openapi: 3.1.0
info:
  title: Chargebee API
  contact:
    name: Chargebee Support
    url: https://www.chargebee.com
    email: support@chargebee.com
  version: 2026-09-24.553c79154f0075cfbab35271eeff8b63a3ed6a86
  x-cb-api-version: 2
  x-cb-product-catalog-version: 2
  x-generated-on: 1790227835401
servers:
- url: "{protocol}://{site}.{environment}:{port}/api/v2"
  variables:
    protocol:
      default: https
      enum:
      - https
    site:
      default: demo
    environment:
      default: chargebee.com
      enum:
      - chargebee.com
    port:
      default: "443"
      enum:
      - "443"
- url: "{protocol}://{site}-test.{environment}:{port}/api/v2"
  variables:
    protocol:
      default: https
      enum:
      - https
    site:
      default: demo
    environment:
      default: chargebee.com
      enum:
      - chargebee.com
    port:
      default: "443"
      enum:
      - "443"
tags:
- name: addresses
  description: Subscriptions can have addresses like "Shipping Address" associated
    with them.
- name: alerts
  description: "An alert defines a threshold rule for usage, spend, or credit balance."
- name: attached_items
  description: Addon-item and charge-item prices are purchased with plan-item prices
    in subscriptions.
- name: batch
  description: Operations on the `batch` resource.
- name: business_entities
  description: The `business_entity` resource represents a business unit or brand
    under your organization.
- name: business_rules
  description: A business rule pairs a condition with the actions to take when that
    condition is met.
- name: business_rulesets
  description: "A business ruleset groups [business rules](/docs/api/business_rules)\
    \ so that they can be evaluated together, in the priority order you assign, using\
    \ the strategy set in `execute_mode`."
- name: cards
  description: "#### Deprecated The [Payment Sources API](/docs/api/payment_sources)\
    \ , with its additional options and improvements, obsoletes the Cards APIs."
- name: comments
  description: Comments are additional information that you can add to your resources.
- name: configurations
  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)."
- name: coupon_codes
  description: Coupon codes are used along with existing coupons in Chargebee.
- name: coupon_sets
  description: A coupon set contains a bunch of coupon codes that can be redeemed
    by your customers when they are checking out.
- name: coupons
  description: Overview -------- Coupons are deductions applied to invoices or invoice
    line items.
- name: credit_notes
  description: "A [Credit Note](https://www.chargebee.com/docs/credit-notes.html)\
    \ is a document that specifies the money owed by a business to its customer."
- name: credit_units
  description: "Credit units power credit-based billing for usage-based products,\
    \ letting you get paid upfront while customers spend credits as they use your\
    \ product's features."
- name: csv_tax_rules
  description: Operations on the `csv_tax_rules` resource.
- name: currencies
  description: "Chargebee's Multi-currency feature allows you to create Plans in multiple\
    \ currencies, enabling your customers to conveniently pay in their preferred local\
    \ currency."
- name: custom_field_configs
  description: "This resource represents the configuration for a specific [custom\
    \ field](/docs/api/advanced-features#custom-fields)."
- name: customers
  description: "Represents a customer, which can be an individual or organization\
    \ that subscribes to your products or services."
- name: differential_prices
  description: Differential pricing helps implement a pricing strategy for addons
    and charges based on the plans they're purchased with.
- name: disputes
  description: Operations on the `disputes` resource.
- name: einvoices
  description: An e-invoice record associated with an invoice or credit note.
- name: entitlements
  description: "The entitlement resource establishes a connection between a [feature](/docs/api/features)\
    \ and an [item](/docs/api/items) or an [item_price](/docs/api/item_prices) in\
    \ Chargebee Billing."
- name: estimates
  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."
- name: events
  description: "### Introduction When important changes occur on your Chargebee site,\
    \ they are recorded as events."
- name: exports
  description: "Export resource represents an export job and contains the status of\
    \ the job and the download URL, if the job is successfully completed."
- name: features
  description: Subscriptions are created in Chargebee using items.
- name: full_exports
  description: The Full Export API allows bulk download of various datasets from a
    secure location where data is loaded daily on a predefined schedule.
- name: gifts
  description: Gift represents a subscription of a customer(**recipient** ) to a 'gift
    plan' which has been gifted by another customer(**gifter**).
- name: grant_blocks
  description: "A grant block represents a bucket of issued credit grants associated\
    \ with a given subscription, `unit_id`, and `unit_type`, allocated either through\
    \ an [item price](/docs/api/item_prices) or via the [allocate](/docs/api/ledger_operations/allocate)\
    \ operation."
- name: hosted_pages
  description: Hosted pages are the easiest way to integrate Chargebee with your website.
- name: in_app_subscriptions
  description: "**Important:** * We've stopped giving access to the legacy solution\
    \ due to the limitations mentioned [here](https://www.chargebee.com/docs/billing/2.0/mobile-subscriptions/mobile-subscriptions-limitations)."
- name: invoices
  description: An invoice is a commercial document representing a sale of products/services
    offered by you to a customer.
- name: item_families
  description: If you're a company that sells multiple product lines then each product
    line or service is an item family in the Chargebee API.
- name: item_prices
  description: An item price is a price point for an item.
- name: items
  description: "When offering subscriptions of products or services, each entity that\
    \ is made available for sale is represented by an \"item\" object."
- name: ledger_account_balances
  description: "Credit Grants ------------- A credit grant is a quantified allocation\
    \ of credits given to a subscription through a configured [item price](/docs/api/item_prices)\
    \ or via the [allocate](/docs/api/ledger_operations/allocate) operation, consumed\
    \ over time through ledger operations."
- name: ledger_operations
  description: A ledger operation represents a single action recorded in the ledger
    that results in a state change.
- name: metered_features
  description: "A metered feature object represents two things: * the [feature](/docs/api/features)\
    \ whose entitlement is consumed based on measured usage."
- name: meters
  description: "A **meter** captures the usage measurement configuration of a [metered\
    \ feature](/docs/api/metered_features)."
- name: non_subscriptions
  description: "**Important:** * We've stopped giving access to the legacy solution\
    \ due to the limitations mentioned [here](https://www.chargebee.com/docs/billing/2.0/mobile-subscriptions/mobile-subscriptions-limitations)."
- name: offer_events
  description: Offer events are used to record and list user interactions with personalized
    offers.
- name: offer_fulfillments
  description: "Offer fulfillment allows you to initiate, update, and retrieve the\
    \ lifecycle of an offer fulfillment, after a personalized offer has been accepted."
- name: omnichannel_one_time_orders
  description: "Represents a one-time in-app product purchase from Apple App Store\
    \ or Google Play Store, normalized into Chargebee's omnichannel model."
- name: omnichannel_subscription_items
  description: "Represents a product entitlement (item) within an [`omnichannel_subscription`](/docs/api/omnichannel_subscriptions)\
    \ purchased on Apple App Store or Google Play Store."
- name: omnichannel_subscriptions
  description: "Represents a subscription purchased and managed in an external app\
    \ marketplace (`apple_app_store` or `google_play_store`), normalized into Chargebee's\
    \ omnichannel model."
- name: orders
  description: '**Note:** This doc is for the latest version of Chargebee Orders.'
- name: payment_intents
  description: A `payment_intent` is created to help you navigate the 3DS flow of
    collecting payment from your customer.
- name: payment_schedule_schemes
  description: "Payment schedules for an invoice refer to a payment structure where\
    \ the `amount_due` on an invoice is divided into smaller, more manageable parts,\
    \ each of which is paid over a specified period."
- name: payment_schedules
  description: "Payment schedules for an invoice refer to a payment structure where\
    \ the `amount_due` on an invoice is divided into smaller, more manageable parts,\
    \ each of which is paid over a specified period."
- name: payment_sources
  description: "**Updates** This API obsoletes the [Cards API](/docs/api/cards) in\
    \ Chargebee."
- name: payment_vouchers
  description: The Payment Voucher resource represents a voucher that has been created
    for a customer to initiate voucher-based payment.
- name: pc2_migration_item_families
  description: Operations on the `pc2_migration_item_families` resource.
- name: pc2_migration_item_prices
  description: Operations on the `pc2_migration_item_prices` resource.
- name: pc2_migration_items
  description: Operations on the `pc2_migration_items` resource.
- name: pc2_migrations
  description: Operations on the `pc2_migrations` resource.
- name: personalized_offers
  description: A Personalized Offer represents the best possible offer for a subscriber
    at a given moment in their lifecycle.
- name: portal_sessions
  description: Customer Portal lets your customers to manage their account and billing
    themselves.
- name: price_variants
  description: "Price variant resource offers businesses the flexibility to manage\
    \ pricing for multiple variations of an [item](/docs/api/items) (plan, addon,\
    \ or charge) in the Product Catalog."
- name: pricing_page_sessions
  description: The `pricing_page_session` resource allows you to create a pricing
    page that incorporates customer and subscription details.
- name: products
  description: Products are offerings that can be sold to customers either as one-time
    purchases or as recurring subscriptions.
- name: promotional_credits
  description: These credits can be provided to the customer for promoting the product.
- name: promotional_grants
  description: Operations on the `promotional_grants` resource.
- name: purchases
  description: '**Deprecated.** The Purchase API is deprecated.'
- name: quotes
  description: A quote is an estimate of the invoice with the charges likely to occur
    when customers buy an item.
- name: ramps
  description: "A `ramp` resource, or subscription ramp, represents a planned change\
    \ to a [`subscription`](/docs/api/subscriptions) that occurs at a future date."
- name: recorded_purchases
  description: '**Important** * Handle the **synchronous** API response first.'
- name: resource_migrations
  description: Resource Migration is used for finding the status of customer migration
    between Chargebee sites.
- name: rules
  description: Operations on the `rules` resource.
- name: site_migration_details
  description: Site Migration details is used for finding the records that are moved
    in and moved out from one Chargebee site to another.
- name: site_pc_meta_records
  description: Operations on the `site_pc_meta_records` resource.
- name: subscriptions
  description: A Chargebee subscription connects a customer record to products/services.
- name: time_machines
  description: "Time Machine is a simulation feature which imitates the key characteristics,\
    \ behaviours and functions of the billing configurations."
- name: tokens
  description: Tokenization hides sensitive payment information into a unique token
    for a secure transaction.
- name: transactions
  description: "This resource represents the [transaction](https://www.chargebee.com/docs/transactions.html)\
    \ event that has happened in your account."
- name: unbilled_charges
  description: "Unbilled charge represents the charges that are held by passing `invoice_immediately`\
    \ in various operations such as update subscription, add charge, create subscription,\
    \ etc."
- name: usage_events
  description: "This resource allows you to record usage events, which are essential\
    \ for usage-based billing."
- name: usage_files
  description: Represents a file containing usage events that has been uploaded for
    processing.
- name: usages
  description: "**Advanced Usage-Based Billing** For high-scale usage ingestion, use\
    \ [Advanced Usage-Based Billing](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/understanding-usages)\
    \ with the [Usage Events API](/docs/api/usage_events)."
- name: variants
  description: A product variant is a specific product version with a unique combination
    of product option values.
- name: vaulted_payment_methods
  description: Operations on the `vaulted_payment_methods` resource.
- name: virtual_bank_accounts
  description: "A virtual bank account gives customers a dedicated account to pay\
    \ into, so you don't share your organization's sensitive bank account details\
    \ with them."
- name: webhook_endpoints
  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."
paths:
  /subscriptions/{subscription-id}/remove_advance_invoice_schedule:
    post:
      tags:
      - subscriptions
      summary: Remove an advance invoice schedule
      description: |
        **Caution**

        * This API will return an error when [multi-frequency billing](/docs/api/subscriptions#subscription-billing-frequencies) is enabled.

        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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing subscription
                  advance_invoice_schedules:
                    type: array
                    description: |
                      Resource object representing advance_invoice_schedule
                    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}/update_for_items:
    post:
      tags:
      - subscriptions
      summary: Update a subscription
      description: "Updates a subscription by modifying its item prices, coupons,\
        \ billing configuration, payment method, and other attributes. Any parameters\
        \ not provided remain unchanged. The changes can be applied immediately, scheduled\
        \ for a future date, or even backdated to a past date.  \n\n### Impacts\n\n\
        **#### Subscription and Ramps: Impact on existing scheduled changes**  \n\
        * If the subscription has existing scheduled changes, the behavior depends\
        \ on whether [Ramps](/docs/api/ramps) are enabled:\n  * **Ramps disabled**:\
        \ Any existing scheduled change on the subscription is deleted.\n  * **Ramps\
        \ enabled with compatibility mode** :\n    * If only one ramp is present:\n\
        \      * If the ramp was created using this API, the ramp is deleted.\n  \
        \    * If the ramp was created using the [Create a ramp API](/docs/api/ramps/create-a-ramp),\
        \ and the date-time of the new change is before the date-time of the ramp,\
        \ then the ramp is moved to `draft` status if the [auto-draft conditions](/docs/api/ramps/ramp-object#auto-draft)\
        \ are met.\n    * If multiple ramps are present: all ramps after the date-time\
        \ of the new change are moved to `draft` status if the [auto-draft conditions](/docs/api/ramps/ramp-object#auto-draft)\
        \ are met.\n* For more details, see [Ramps API compatibility mode](/docs/api/subscriptions#ramps-compat-mode).\
        \  \n**#### Subscription: Other impacts**  \n* When the [Remove mandatory\
        \ add-ons from old plan during subscription plan update](https://www.chargebee.com/docs/2.0/subscriptions#remove-mandatory-addons)\
        \ setting is enabled on your Chargebee site, all [mandatory addons](/docs/api/attached_items)\
        \ with the old plan are automatically removed during the subscription update\
        \ to a new plan.  \n**#### Invoice**  \n* If an invoice is generated, any\
        \ available [credits and excess payments](/docs/api/customers#balances) for\
        \ the customer are automatically applied subject to [limits set at the site\
        \ level](https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/credit-notes#credits-flexibility),\
        \ which can be overridden for subscriptions via [`subscription.billing_override`](/docs/api/subscriptions#billing_override).\
        \  \n**#### Credit Note**  \n* When the subscription change occurs in the\
        \ middle of a billing term, and `prorate` is `true`, prorated [credits](/docs/api/credit_notes)\
        \ may be created for the unused service periods of the subscription items.\
        \  \n**#### Payment Source**  \n* If `payment_intent`, `payment_method`, or\
        \ `card` parameters are provided, a new [payment source](/docs/api/payment_sources)\
        \ is created for the customer and associated with the subscription as the\
        \ [`payment_source_id`](/docs/api/subscriptions/subscription-object#payment_source_id).\
        \  \n\n### Use Cases\n\n#### Add item prices to the subscription\n\nTo add\
        \ new item prices to the subscription, pass them in the `subscription_items`\
        \ parameter.\n\n##### Example\n\nConsider a subscription with the following\
        \ item prices:\n\n* `plan-a-monthly-usd`\n* `addon-b-monthly-usd`\n\nIf you\
        \ call this API with the following item price:\n\n* `addon-c-monthly-usd`\n\
        \nThe subscription will be updated to include the following item prices:\n\
        \n* `plan-a-monthly-usd`\n* `addon-b-monthly-usd`\n* `addon-c-monthly-usd`\
        \  \n\n#### Replace item prices in the subscription\n\nTo replace all existing\
        \ item prices in the subscription with a new set of item prices, include the\
        \ `replace_items_list` parameter and set it to `true`.\n\n##### Example\n\n\
        Consider a subscription with the following item prices:\n\n* `plan-a-monthly-usd`\n\
        * `addon-b-monthly-usd`\n\nIf you call this API with the following item prices\
        \ and set `replace_items_list` to `true`:\n\n* `plan-c-monthly-usd`\n* `addon-d-monthly-usd`\n\
        \nThe subscription will be updated to include only the new item prices:\n\n\
        * `plan-c-monthly-usd`\n* `addon-d-monthly-usd`  \n\n#### Change the payment\
        \ method during the update\n\nAn update can generate an invoice for prorated\
        \ charges, which Chargebee attempts to collect immediately when `auto_collection`\
        \ is `on`. Pass the payment details in this API call when the customer supplies\
        \ a new payment method as part of the update, or when the resulting charge\
        \ requires [Strong Customer Authentication](https://www.chargebee.com/docs/payments/2.0/others/psd2-sca)\
        \ (SCA) (i.e. 3D-Secure).\n\nChargebee creates the [payment source](/docs/api/payment_sources),\
        \ associates it with the subscription as the [`payment_source_id`](/docs/api/subscriptions/subscription-object#payment_source_id),\
        \ and collects the invoice using it. This means you do not need a separate\
        \ [Create a payment source API](/docs/api/payment_sources/create-using-payment-intent)\
        \ call before updating the subscription.\n\nUse `payment_intent`, `payment_method`,\
        \ or `card`, depending on how you capture the payment details.\n\n##### Using\
        \ `payment_intent`\n\nUsing payment intents is the recommended way to create\
        \ a payment source in Chargebee for both SCA and non-SCA flows.\n\n1. Create\
        \ a `payment_intent` resource by calling the [Create a payment intent API](/docs/api/payment_intents/create-a-payment-intent).\
        \ Set `amount` to the amount due for this update, which you can retrieve using\
        \ the [Estimate for updating a subscription API](/docs/api/estimates/estimate-for-updating-a-subscription).\n\
        2. Pass the `payment_intent` object to your frontend and use Chargebee.js\
        \ to capture the payment source details from the customer. Use [Payment Components](https://www.chargebee.com/docs/payments/2.0/payment-components/overview)\
        \ to show payment method UIs and collect payment method details from the customer.\n\
        3. Listen to the [`payment_intent_updated`](/docs/api/events#payment_intent_updated)\
        \ event. Once the `payment_intent.status` is `authorized`, pass the `payment_intent.id`\
        \ using the `payment_intent[id]` parameter in this API call.\n\n##### Using\
        \ `payment_method`\n\nIf you prefer to use the payment gateway's SDKs to capture\
        \ the payment method details, you can then use the `payment_method` parameter\
        \ in this API to pass the payment method token and other details.\n\n1. Use\
        \ the JavaScript library of your payment gateway to capture the payment method\
        \ details. Examples include:\n   * [Stripe.js](https://stripe.com/docs/js)\n\
        \   * [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2)\n\
        \   * [Accept.js](https://developer.authorize.net/api/reference/features/acceptjs.html)\
        \ (if you use [Authorize.Net](https://developer.authorize.net/api/reference/features/acceptjs.html))\n\
        \   * Adyen's [Client-Side Encryption](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/cse-integration-ecommerce)\
        \ (if you use Adyen)\n2. Pass the payment method token using the `payment_method[reference_id]`\
        \ or `payment_method[tmp_token]` parameter along with any additional parameters\
        \ required by the payment gateway to create the payment source.\n\n##### Using\
        \ `card`\n\nIf you are PCI compliant, you can pass raw card details via this\
        \ API. Use the `card` parameter to pass the card details.\n"
      operationId: update_subscription_for_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
                mandatory_items_to_remove:
                  type: array
                  deprecated: false
                  description: |
                    A list of item 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
                replace_items_list:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Determines whether the provided `subscription_items` replace existing subscription items or are added to the existing list.

                    **When `subscription_items` includes a plan**

                    * `true`: The entire subscription item list (plan and addons) is replaced by the provided list.
                    * `false`: The provided items are added to the existing list. If multi-plan subscriptions is disabled, the existing plan item price is replaced. If multi-plan subscriptions is enabled, the existing plan item price is retained.

                    **When `subscription_items` contains only addons**

                    * The existing plan on the subscription is always retained; it is not replaced.
                    * `true`: Existing addons are replaced by the provided addons, except mandatory addons (auto-attached to the plan). Mandatory addons are kept unless you list them in `mandatory_items_to_remove`. The subscription will have the current plan, the addons you passed, plus any existing mandatory addons not in `mandatory_items_to_remove`.
                    * `false`: The provided addons are added to the existing addons.
                  example: null
                net_term_days:
                  type: integer
                  format: int32
                  deprecated: false
                  description: "Updates [Net D](https://www.chargebee.com/docs/net_d.html)\
                    \ for the subscription. Net D is the number of days from [`invoice.date`](/docs/api/invoices/invoice-object#date)\
                    \ until payment for the invoice is due.  \n**Constraints**\n\n\
                    * The value must match one of the options defined in your [site\
                    \ configuration](https://www.chargebee.com/docs/net_d.html#enable-net-d-for-chargebee-invoices).\n\
                    * To reset this attribute, set the value to `-1`. When reset,\
                    \ it is not returned by the API, and the `net_term_days` value\
                    \ set at the [customer level](/docs/api/customers/customer-object#net_term_days)\
                    \ is used instead.\n"
                  example: null
                invoice_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: "The document date displayed on the invoice PDF. Use\
                    \ this parameter to backdate the invoice for reasons such as booking\
                    \ revenue for a previous date or when the subscription is effective\
                    \ as of a past date.  \n**Prerequisites**\n\n* `invoice_immediately`\
                    \ must be `true`.  \n**Default value**\n\n* The current date is\
                    \ used when not provided.  \n**Constraints**\n\n* Must be a date-timein\
                    \ the past.\n* Must not be more than one calendar month into the\
                    \ past. For example, if today is 13th January, you cannot pass\
                    \ a value that is earlier than 13th December.\n* It must not be\
                    \ earlier than `changes_scheduled_at`, `reactivate_from`, or `trial_end`.\
                    \  \n**Impacts**\n\n* [`taxes[]`](/docs/api/invoices#taxes) and\
                    \ [`line_item_taxes[]`](/docs/api/invoices#line_item_taxes) are\
                    \ computed based on the tax configuration as of `invoice_date`.\n\
                    * If `create_pending_invoices` is set to `true`, and if the site\
                    \ is [configured](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing)\
                    \ to set invoice dates to date of closing, then upon invoice closure,\
                    \ this date is changed to the invoice closing date.\n"
                  example: null
                start_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: "The new start date of a `future` subscription.  \n\
                    **Prerequisites**\n\n* The subscription `status` must be `future`.\n"
                  example: null
                trial_end:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: "The time at which the trial has ended or will end\
                    \ for the subscription. Set to `0` to have no trial period.  \n\
                    **Constraints**\n\n* This is only allowed when the subscription\
                    \ `status` is `future`, `in_trial`, or `cancelled`.\n* The value\
                    \ must not be earlier than `changes_scheduled_at` or `start_date`.\n\
                    * This parameter can be backdated (set to a value in the past)\
                    \ only when the subscription is in `cancelled` or `in_trial` status.\
                    \ Do this to keep a record of when the trial ended.  \n**Impact**\n\
                    \n* When `trial_end` is backdated, the subscription immediately\
                    \ goes into `active` or `non_renewing` status.\n"
                  example: null
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: "The number of billing cycles the subscription runs\
                    \ before canceling automatically.  \n**Default value**\n\n* The\
                    \ value set for the [plan-item price](/docs/api/item_prices#billing_cycles)\
                    \ is used when not provided.\n"
                  minimum: 0
                  example: null
                terms_to_charge:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of subscription billing cycles to [invoice in advance](https://www.chargebee.com/docs/advance-invoices.html).
                    If a new term is started for the subscription due to this API call, then `terms_to_charge`
                    is inclusive of this new term. See description for the `force_term_reset`
                    parameter to learn more about when a subscription term is reset.
                  minimum: 1
                  example: null
                reactivate_from:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    If the subscription `status`
                    is `cancelled`
                    and it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.
                    **Note:**
                    It is recommended not to pass this parameter along with `changed_scheduled_at`.
                    `reactivate_from`
                    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:

                    * Backdating must be enabled for subscription reactivation operations.
                    * 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.
                    * The date is on or after the last date/time any of the product catalog items of the subscription were changed.
                    * 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, `changes_scheduled_at` cannot be earlier than 14th February.
                  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: "The list of coupons to be applied to this subscription.\
                    \ You can provide [coupon IDs](/docs/api/coupons/coupon-object#id)\
                    \ or [coupon codes](/docs/api/coupon_codes/coupon-code-object#code).\
                    \  \n**Note**\n\n* If `changes_scheduled_at` is in the past, you\
                    \ can use currently available coupons even if those coupons were\
                    \ not available on the date of the change.\n"
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                replace_coupon_list:
                  type: boolean
                  default: false
                  deprecated: false
                  description: "Determines whether the provided `coupon_ids` replace\
                    \ or add to the [existing coupons](/docs/api/subscriptions#coupons)\
                    \ on the subscription.  \n**Default value**\n\n* `false` (the\
                    \ provided coupons are added to the existing coupons)\n"
                  example: null
                prorate:
                  type: boolean
                  deprecated: false
                  description: |
                    When this subscription change is set to occur in the middle of the subscription term, `prorate` determines whether [prorated credits and charges](https://www.chargebee.com/docs/billing/2.0/subscriptions/proration#proration-mechanism) are created for the change.

                    * When `true`: Prorated credits or charges are created as applicable for this change.
                    * When `false`: The subscription is changed without creating any credits or charges.


                    **Default value**
                    The value configured in the [site settings](https://www.chargebee.com/docs/2.0/proration.html#proration-for-subscription-change) is used when not provided.



                    **Constraints**
                    If you set `prorate` to `true` for a change made mid-term in the billing cycle, credits are **not** created if all of the following were true for a previous change in the same billing term:


                    * The earlier change had `prorate` set to `false`.
                    * No changes were made to the subscription's billing term.
                    * Only the subscription's items or their prices were updated.
                  example: null
                end_of_term:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    **Deprecated**

                    * This option is deprecated; use the [Create a ramp API](/docs/api/ramps/create-a-ramp) instead.
                    * If you pass this parameter along with `change_option`, then `change_option` takes precedence.

                    This parameter has the same effect as setting the `change_option` parameter to `end_of_term`.
                  example: null
                force_term_reset:
                  type: boolean
                  default: false
                  deprecated: false
                  description: "Forces the subscription term to start from the date\
                    \ of the subscription change when updating to a plan-item price\
                    \ with the same billing period as the current plan-item price.\
                    \  \n**Default value**\n\n* `false`  \n**Constraints**\n\n* Only\
                    \ applicable when the new plan-item price has the same billing\
                    \ period as the current plan-item price. When the billing period\
                    \ differs, the term is always reset regardless of this parameter's\
                    \ value.\n* Only takes effect when `end_of_term` is `false`.\n\
                    * If you pass `force_term_reset`, you must also pass `invoice_usages`\
                    \ with the same value when **all** of the following site configuration\
                    \ settings are enabled:\n  * [Usage-based billing](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/setting-up-usage-based-billing)\n\
                    \  * Mid-term changes for usage-based items\n  * [Invoice and\
                    \ charge for usage-based items when a subscription is changing](https://www.chargebee.com/docs/billing/2.0/subscriptions/metered_billing#configuring-metered-billing)\n"
                  example: null
                reactivate:
                  type: boolean
                  deprecated: false
                  description: "Determines whether to reactivate a cancelled subscription\
                    \ when making this API request.  \n**Default value**\n\n* `true`\
                    \ when `subscription_items` or `coupons` are provided, unless\
                    \ explicitly set to `false`.  \n**Required if**\n\n* The subscription\
                    \ `status` is `cancelled` and you want to reactivate it.\n"
                  example: null
                token_id:
                  type: string
                  deprecated: false
                  description: "The Chargebee payment token generated by [Chargebee.js](https://www.chargebee.com/docs/payments/2.0/card-components-and-helpers/3ds-helper#using-the-gateways-hosted-fields).\
                    \  \n**Note** :\nThe payment token created via Chargebee.js uses\
                    \ the gateway selected through [Smart Routing](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/gateway_settings#smart-routing).\n\
                    Explicitly passing a `gateway_id`\nin this API call will not override\
                    \ the gateway associated with the token.\n"
                  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](/docs/api/advanced-features#metadata)\
                    \ that provides extra information about the subscription.  \n\
                    **Constraints**\n\n* There's a character limit of 65,535.\n"
                  example: null
                invoice_immediately:
                  type: boolean
                  deprecated: false
                  description: "Determines whether charges raised immediately for\
                    \ the subscription are invoiced immediately or added to [unbilled\
                    \ charges](/docs/api/unbilled_charges).  \n**Default value**\n\
                    \n* The value configured in the [site settings](https://www.chargebee.com/docs/unbilled-charges.html#configuration)\
                    \ is used when not provided.  \n**Note:**\n\n* Any charges scheduled\
                    \ to be raised in the future are not affected by this parameter.\n"
                  example: null
                override_relationship:
                  type: boolean
                  deprecated: false
                  description: |
                    If `true`
                    , ignores the [hierarchy relationship](/docs/api/customers/customer-object#relationship)
                    and uses customer as payment and invoice owner.
                  example: null
                changes_scheduled_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: "The date-time at which the subscription change is\
                    \ to happen or has happened.  \n**Deprecated for scheduling changes**\n\
                    \n* Setting this parameter to a future date-time for scheduling\
                    \ changes is deprecated. Use the [Create a ramp API](/docs/api/ramps/create-a-ramp)\
                    \ instead.  \n**Required if**\n\n* `change_option` is set to `specific_date`.\
                    \  \n**Constraints**\n\n* Do not pass this parameter along with\
                    \ `reactivate_from`.  \n\n**Backdated changes**\n`changes_scheduled_at`\
                    \ 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:\n\n\n* Backdating must be [enabled](https://www.chargebee.com/docs/billing/2.0/subscriptions/backdating#configuring-backdated-subscription-actions-and-invoicing)\
                    \ for subscription change operations.\n* Only the following changes\
                    \ can be backdated:\n  * Changes in the recurring items or their\
                    \ prices.\n  * Addition of non-recurring items.\n* Subscription\
                    \ `status` is `active`, `cancelled`, or `non_renewing`.\n* 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.\n* The date is on or after `current_term_start`.\n\
                    * The date is on or after the last date/time any of the following\
                    \ changes were made:\n  * Changes in the recurring items or their\
                    \ prices.\n  * Addition of non-recurring items.\n"
                  example: null
                change_option:
                  type: string
                  deprecated: false
                  description: "Specifies when the subscription change takes effect.\
                    \  \n\n**Constraints**\nRegardless of the value of the `change_option`\
                    \ parameter, the following parameters always take effect immediately:\n\
                    \n\n* `auto_collection`\n* `shipping_address`\n* `po_number`\n\
                    * Any subscription-level [custom field](/docs/api/advanced-features#custom-fields)\
                    \ parameters  \n**See also**\n\n* [Impacts on existing scheduled\
                    \ changes](/docs/api/subscriptions/update-subscription-for-items#impact-scheduled-changes).\n\
                    \n* end_of_term -\n  **Deprecated**\n\n  This option is deprecated;\
                    \ use the [Create a ramp API](/docs/api/ramps/create-a-ramp) instead.\n\
                    \n  The change is carried out at the end of the current billing\
                    \ cycle of the subscription.\n* specific_date -\n  **Deprecated\
                    \ for scheduling changes**\n\n  This option is deprecated for\
                    \ scheduling changes to occur at a future date-time, use the [Create\
                    \ a ramp API](/docs/api/ramps/create-a-ramp) instead.\n\n  Executes\
                    \ the change on a specified date. The change occurs as of the\
                    \ date-time defined in `changes_scheduled_at`.\n* immediately\
                    \ - The subscription change takes effect immediately.\n"
                  enum:
                  - immediately
                  - end_of_term
                  - specific_date
                  example: null
                contract_term_billing_cycle_on_renewal:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as `billing_cycles`
                    or a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)
                    .
                  maximum: 100
                  minimum: 1
                  example: null
                free_period:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The period of time by which the first billing term after trial is extended free of charge. The value is expressed in the time unit specified by `free_period_unit`. For example, `3` with `free_period_unit` = `month` adds 3 free months to the first paid term when the subscription becomes active.
                  minimum: 1
                  example: null
                free_period_unit:
                  type: string
                  deprecated: false
                  description: "The time unit for `free_period`.  \n\n**Constraints**\n\
                    Must be equal to or lower than the [`period_unit`](/docs/api/item_prices#period_unit)\
                    \ of the plan [item price](/docs/api/subscriptions/update-subscription-for-items#subscription_items_item_price_id)\
                    \ of the subscription.\n\n* week - Charge based on week(s)\n*\
                    \ month - Charge based on month(s)\n* day - Charge based on day(s)\n\
                    * year - Charge based on year(s)\n"
                  enum:
                  - day
                  - week
                  - month
                  - year
                  example: null
                create_pending_invoices:
                  type: boolean
                  deprecated: false
                  description: "Determines whether invoices for this subscription\
                    \ are generated with a `pending` status.  \n**Prerequisites**\n\
                    \n* [Metered Billing](https://www.chargebee.com/docs/metered_billing.html)\
                    \ must be enabled for the site.  \n**Default behavior**\n\n* Set\
                    \ to `true` automatically when the subscription has item prices\
                    \ that belong to `metered` items.  \n**Use case**\n\n* Pending\
                    \ invoices allow you to inspect all charges on each invoice before\
                    \ closing it.\n"
                  example: null
                auto_close_invoices:
                  type: boolean
                  deprecated: false
                  description: "Overrides the [site-level setting](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing)\
                    \ for auto-closing invoices for this subscription.  \n**Prerequisites**\n\
                    \n* Auto-closing invoices must be enabled for the site.  \n**Constraints**\n\
                    \n* This attribute has a higher precedence than the same attribute\
                    \ at the [customer level](customers/customer-object#auto_close_invoices).\n"
                  example: null
                trial_end_action:
                  type: string
                  deprecated: false
                  description: |
                    Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/2.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/2.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/2.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
                invoice_usages:
                  type: boolean
                  default: false
                  deprecated: false
                  description: "Determines whether to invoice the overages for metered\
                    \ items during the subscription change.  \n**Prerequisites**\n\
                    \n* [Usage-based billing](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/setting-up-usage-based-billing)\
                    \ must be enabled.\n* 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)\
                    \ to enable the backend site setting `invoice_overages` for invoicing\
                    \ overages during subscription changes.  \n**Constraints**\n\n\
                    * If you pass `invoice_usages`, you must also pass `force_term_reset`\
                    \ with the same value when **all** of the following site configuration\
                    \ settings are enabled:\n  * Mid-term changes for usage-based\
                    \ items\n  * [Invoice and charge for usage-based items when a\
                    \ subscription is changing](https://www.chargebee.com/docs/billing/2.0/subscriptions/metered_billing#configuring-metered-billing)\n"
                  example: null
                card:
                  type: object
                  deprecated: false
                  description: "Parameters for card. Use this parameter to pass raw\
                    \ card details.  \nPassing raw card data via API involves PCI\
                    \ liability at your end due to the sensitivity of the data.\n"
                  properties:
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: "The gateway account in which these card details\
                        \ are stored.  \n**Required when**\n\n* All of the following\
                        \ conditions are met together:\n* Passing `card` parameter.\n\
                        * There are multiple [payment gateway](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/gateway_settings)\
                        \ accounts configured for the site.\n* [Smart Routing](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/gateway_settings#smart-routing)\
                        \ is not configured for card payments.\n"
                      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 16 digit credit card number.  \nIf 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.\n"
                      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 supported\
                        \ only for Stripe, Adyen, and Chargebee Payments.\n\n* cartes_bancaires\
                        \ - A Cartes Bancaires card scheme.\n* mastercard - A MasterCard\
                        \ scheme.\n* dankort - A Dankort card scheme. Supported only\
                        \ for Adyen and Chargebee Payments.\n* visa - A Visa card\
                        \ scheme.\n"
                      enum:
                      - cartes_bancaires
                      - mastercard
                      - visa
                      - dankort
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `billing_state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    billing_state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `billing_state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      maxLength: 50
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |
                        * `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal).

                          * `payer`: User related information.
                            * `country_of_residence`: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a [two-character ISO code](https://docs.checkout.com/resources/codes/country-codes).
                            * `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
                        * `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
                        * `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user's `device_session_id` can be added to perform [additional validation](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                            * `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
                        * `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
                        * `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                        * `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.

                          * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
                        * `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.

                          * `payer`: User related information.
                            * `document`: Document is the user's identification number based on their country.
                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device
                      example: null
                  example: null
                payment_method:
                  type: object
                  deprecated: false
                  description: |
                    Use this parameter if you prefer to use the payment gateway's SDKs to capture the payment method details and pass the payment method token and other details here. See [use cases](/docs/api/subscriptions/update-subscription-for-items#use-cases) to learn more.
                  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\n* grab_pay - Payments made\
                        \ via GrabPay\n* go_pay - Payments made via GoPay\n* nequi\
                        \ - Payments made via Nequi.\n* google_pay - Payments made\
                        \ via Google Pay.\n* after_pay - Payments made via Afterpay\n\
                        * qpay - Payments made via Qpay.\n* pix - Payments made via\
                        \ Pix\n* pay_by_bank - Pay By Bank\n* sofort - Payments made\
                        \ via Sofort.\n* twint - Payments made via Twint\n* netbanking_emandates\
                        \ - Netbanking (eMandates) Payments.\n* apple_pay - Payments\
                        \ made via Apple Pay.\n* unionpay - Payments made via UnionPay.\n\
                        * giropay - Payments made via giropay.\n* direct_debit - Represents\
                        \ bank account for which the direct debit or ACH agreement/mandate\
                        \ is created.\n* rakuten_pay - Payments made via Rakuten Pay.\n\
                        * ovo - Payments made via OVO.\n* mercado_pago - Payments\
                        \ made via Mercado Pago.\n* paypay - Payments made via PayPay\n\
                        * south_korean_cards - Payments made via South Korean Cards\n\
                        * bancontact - Payments made via Bancontact Card.\n* upi -\
                        \ UPI Payments.\n* revolut_pay - Payments made via Revolut\
                        \ Pay.\n* stablecoin - Payments made via Stablecoin.\n* alipay\
                        \ -\n  Payments made via Alipay.  \n  This payment source\
                        \ is deprecated.\n* tamara - Payments made via Tamara.\n*\
                        \ payme - Payments made via PayMe\n* pay_to - Payments made\
                        \ via PayTo\n* pay_co - Payments made via PayCo\n* picpay\
                        \ - Payments made via PicPay.\n* kakao_pay - Payments made\
                        \ via Kakao Pay.\n* fpx - Payments made via FPX.\n* wechat_pay\
                        \ -\n  Payments made via WeChat Pay.  \n  This payment source\
                        \ is deprecated.\n* sepa_instant_transfer - Payments made\
                        \ via Sepa Instant Transfer\n* dotpay - Payments made via\
                        \ Dotpay.\n* p24 - Payments made via Przelewy24 (P24).\n*\
                        \ klarna - Payments made via Klarna.\n* paypal_express_checkout\
                        \ - Payments made via PayPal Express Checkout.\n* ideal -\
                        \ Payments made via iDEAL.\n* affirm_pay - Payments made via\
                        \ Affirm Pay.\n* electronic_payment_standard - Electronic\
                        \ Payment Standard\n* generic - Payments made via Generic\
                        \ Payment Method.\n* klarna_pay_now - Payments made via Klarna\
                        \ Pay Now\n* faster_payments - Payments made via Faster Payments\n\
                        * thai_qr - Payments made via Thai QR.\n* swish - Payments\
                        \ made via Swish\n* venmo - Payments made via Venmo\n* payconiq_by_bancontact\
                        \ - Payments made via Payconiq by Bancontact.\n* naver_pay\
                        \ - Payments made via Naver Pay.\n* wero - Payments made via\
                        \ Wero.\n* touch_n_go - Payments made via Touch 'n Go.\n*\
                        \ momo - Payments made via MoMo.\n* blik - Payments made via\
                        \ BLIK.\n* dana - Payments made via Dana.\n* automated_bank_transfer\
                        \ - Represents virtual bank account using which the payment\
                        \ will be done.\n* amazon_payments - Payments made via Amazon\
                        \ Payments.\n* gcash - Payments made via GCash.\n* card -\
                        \ Card based payment including credit cards and debit cards.\
                        \ Details about the card can be obtained from the card resource.\n\
                        * online_banking_poland - Payments made via Online Banking\
                        \ Poland\n* nupay - Payments made via NuPay.\n* trustly -\
                        \ Trustly\n* kbc_payment_button - KBC Payment Button\n* alipay_hk\
                        \ - Payments made via Alipay HK.\n* cash_app_pay - Payments\
                        \ 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
                      - alipay_hk
                      - paypay
                      - gcash
                      - south_korean_cards
                      - paynow
                      - bizum
                      - promptpay
                      - dana
                      - touch_n_go
                      - tamara
                      - qpay
                      - ovo
                      - momo
                      - mercado_pago
                      - nequi
                      - nupay
                      - picpay
                      - thai_qr
                      - blik
                      - fpx
                      - wero
                      - p24
                      - affirm_pay
                      - rakuten_pay
                      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: |
                        [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)
                        .

                        **Note**:
                        If you enter an invalid country code, the system will return an error.

                        If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)
                        in 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)
                        the Brexit configuration, then `XI`
                        (the code for **United Kingdom - Northern Ireland**
                        ) is available as an option.
                      maxLength: 50
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |
                        * `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal).

                          * `payer`: User related information.
                            * `country_of_residence`: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a [two-character ISO code](https://docs.checkout.com/resources/codes/country-codes).
                            * `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
                        * `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
                        * `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user's `device_session_id` can be added to perform [additional validation](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                            * `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
                        * `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
                        * `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                        * `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.

                          * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
                        * `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.

                          * `payer`: User related information.
                            * `document`: Document is the user's identification number based on their country.
                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device
                      example: null
                  example: null
                payment_intent:
                  type: object
                  deprecated: false
                  description: |
                    Pass these parameters to create a new `payment_source` using an authorized `payment_intent`. This is the recommended way to create a payment source in Chargebee for both [Strong Customer Authentication](https://www.chargebee.com/docs/payments/2.0/others/psd2-sca) (SCA) (i.e. 3D-Secure) and non-SCA flows. See use cases to learn more.
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: "Identifier for the [`payment_intent`](/docs/api/payment_intents)\
                        \ resource. If you provide this parameter, you do not need\
                        \ to pass other `payment_intent` parameters.  \n**Prerequisites**\n\
                        \n* The value of [`payment_intent.status`](/docs/api/payment_intents/payment_intent-object#status)\
                        \ must be `authorized`.\n"
                      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 payment method type.  \n**Default value**\n\
                        \n* `card`\n\n* card - card\n* twint - Payments made via Twint\n\
                        * dotpay - dotpay\n* faster_payments - Faster Payments\n*\
                        \ upi - upi\n* kbc_payment_button - KBC Payment Button\n*\
                        \ klarna - Payments made via Klarna.\n* payme - Payments made\
                        \ via PayMe\n* google_pay - google_pay\n* paypal_express_checkout\
                        \ - paypal_express_checkout\n* pix - Pix\n* klarna_pay_now\
                        \ - Klarna Pay Now\n* ideal - ideal\n* picpay - Payments made\
                        \ via PicPay.\n* ovo - Payments made via OVO.\n* boleto -\
                        \ boleto\n* wechat_pay - Payments made via WeChat Pay.\n*\
                        \ after_pay - Payments made via Afterpay\n* grab_pay - Payments\
                        \ made via GrabPay\n* mercado_pago - Payments made via Mercado\
                        \ Pago.\n* direct_debit - direct_debit\n* sepa_instant_transfer\
                        \ - Sepa Instant Transfer\n* bancontact - bancontact\n* touch_n_go\
                        \ - Payments made via Touch 'n Go.\n* qpay - Payments made\
                        \ via Qpay.\n* momo - Payments made via MoMo.\n* affirm_pay\
                        \ - Payments made via Affirm Pay.\n* kakao_pay - Payments\
                        \ made via Kakao Pay.\n* blik - Payments made via BLIK.\n\
                        * dana - Payments made via Dana.\n* south_korean_cards - Payments\
                        \ made via South Korean Cards\n* swish - Payments made via\
                        \ Swish\n* thai_qr - Payments made via Thai QR.\n* go_pay\
                        \ - Payments made via GoPay\n* trustly - Trustly\n* naver_pay\
                        \ - Payments made via Naver Pay.\n* stablecoin - Payments\
                        \ made via Stablecoin.\n* venmo - Venmo\n* alipay - Payments\
                        \ made via Alipay.\n* tamara - Payments made via Tamara.\n\
                        * pay_to - PayTo\n* pay_co - Payments made via PayCo\n* cash_app_pay\
                        \ - Payments made via Cash App Pay.\n* rakuten_pay - Payments\
                        \ made via Rakuten Pay.\n* alipay_hk - Payments made via Alipay\
                        \ HK.\n* netbanking_emandates - netbanking_emandates\n* nequi\
                        \ - Payments made via Nequi.\n* paypay - PayPay\n* payconiq_by_bancontact\
                        \ - Payments made via Payconiq by Bancontact.\n* p24 - Payments\
                        \ made via Przelewy24 (P24).\n* electronic_payment_standard\
                        \ - Electronic Payment Standard\n* wero - Payments made via\
                        \ Wero.\n* pay_by_bank - Pay By Bank\n* apple_pay - apple_pay\n\
                        * online_banking_poland - Online Banking Poland\n* gcash -\
                        \ Payments made via GCash.\n* nupay - Payments made via NuPay.\n\
                        * giropay - giropay\n* sofort - sofort\n* amazon_payments\
                        \ - Amazon Payments\n* fpx - Payments made via FPX.\n* revolut_pay\
                        \ - Payments made via Revolut Pay.\n"
                      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
                      - alipay_hk
                      - paypay
                      - gcash
                      - south_korean_cards
                      - paynow
                      - bizum
                      - promptpay
                      - dana
                      - touch_n_go
                      - tamara
                      - qpay
                      - ovo
                      - momo
                      - mercado_pago
                      - nequi
                      - nupay
                      - picpay
                      - thai_qr
                      - blik
                      - fpx
                      - wero
                      - p24
                      - affirm_pay
                      - rakuten_pay
                      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: |
                        * `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal).

                          * `payer`: User related information.
                            * `country_of_residence`: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a [two-character ISO code](https://docs.checkout.com/resources/codes/country-codes).
                            * `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
                        * `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
                        * `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user's `device_session_id` can be added to perform [additional validation](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                            * `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
                        * `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
                        * `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                        * `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.

                          * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
                        * `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.

                          * `payer`: User related information.
                            * `document`: Document is the user's identification number based on their country.
                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)\n\
                        .  \n**Brexit**\n\nIf you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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/2.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: |
                        The VAT/tax registration number for the customer. For customers with [billing_address](/docs/api/customers/customer-object#billing_address)

                        `country`
                        as
                        `XI`
                        (which is **United Kingdom - Northern Ireland**
                        ), the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number)
                        can be overridden by setting
                        [vat_number_prefix](/docs/api/customers/customer-object#vat_number_prefix)
                        .
                      maxLength: 20
                      example: null
                    vat_number_prefix:
                      type: string
                      deprecated: false
                      description: |
                        An overridden value for the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number).
                        Only applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)

                        `country`
                        as `XI`
                        (which is **United Kingdom - Northern Ireland**
                        ).

                        When you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)
                        in 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)
                        the Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)

                        `country`
                        as `XI`.
                        That's the code for **United Kingdom - Northern Ireland** .
                        The first two characters of the VAT number in such a case is
                        `XI`
                        by default. However, if the VAT number was registered in UK, the value should be `GB`.
                        Set
                        `vat_number_prefix`
                        to `GB`
                        for such cases.
                      maxLength: 10
                      example: null
                    entity_identifier_scheme:
                      type: string
                      deprecated: false
                      description: "The Peppol BIS scheme associated with the [vat_number](/docs/api/customers/customer-object#vat_number)\n\
                        of the customer. This helps identify the specific type of\
                        \ customer entity. For example, `DE:VAT`\nis used for a German\
                        \ business entity while `DE:LWID45`\nis used for a German\
                        \ government entity. The value must be from the list of possible\
                        \ values and must correspond to the country provided under\
                        \ `billing_address.country`.\nSee [list of possible values](https://www.chargebee.com/docs/e-invoicing.html#supported-countries)\n\
                        .  \n**Tip:**\n\nIf there are additional entity identifiers\
                        \ for the customer not associated with the `vat_number`, they\
                        \ can be provided as the `entity_identifiers[]` array.\n"
                      maxLength: 50
                      example: null
                    is_einvoice_enabled:
                      type: boolean
                      deprecated: false
                      description: "Determines whether the customer is e-invoiced.\
                        \ When set to `true`\nor not set to any value, the customer\
                        \ is e-invoiced so long as e-invoicing is enabled for their\
                        \ country (`billing_address.country`\n). When set to `false`\n\
                        , the customer is not e-invoiced even if e-invoicing is enabled\
                        \ for their country.  \n**Tip:**\n\nIt 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.\n"
                      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: "The standard used for specifying the `entity_identifier_scheme`.\n\
                        Currently only `iso6523-actorid-upis`\nis supported and is\
                        \ used by default when not provided.  \n**Tip:**\n\nIf there\
                        \ are additional entity identifiers for the customer not associated\
                        \ with the `vat_number`, they can be provided as the `entity_identifiers[]`\
                        \ array.\n"
                      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: |
                        Confirms that a customer is registered under GST. If set to `true`
                        then the [Reverse Charge Mechanism](https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism)
                        is applicable. This field is applicable only when Australian GST is configured for your site.
                      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: |
                        Action to be taken when the contract term completes.

                        * renew_once -
                          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 [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).

                          * The `action_at_term_end` for the new contract term is set to `cancel`.
                        * cancel - Contract term completes and subscription is canceled.
                        * evergreen - Contract term completes and the subscription renews.
                        * renew -
                          * Contract term completes and a new contract term is started for the number of billing cycles specified in [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).
                          * The `action_at_term_end` for the new contract term is set to `renew`.
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      - renew_once
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        The number of days before [`contract_end`](/docs/api/contract_terms/contract_term-object#contract_end)
                        , 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.
                      example: null
                  example: null
                billing_override:
                  type: object
                  deprecated: false
                  description: |
                    Specify limits on how credits and payments are applied to individual invoices for the subscription. 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 enable this feature. Note: These limits do not apply to [consolidated invoices](https://www.chargebee.com/docs/2.0/consolidated-invoicing.html)
                    .
                  properties:
                    max_excess_payment_usage:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Maximum amount of [excess payments](/docs/api/customers/customer-object#excess_payments) that can be automatically applied to a single invoice associated with this subscription.

                        **Supported values:**

                        * `-1`: Set to `-1` to reset the subscription-level limit. In this case, the site-level configuration will apply, whether it is configured to Auto Apply or Do Not Auto Apply excess payments.
                        * `0`: Disable auto-application for the subscription. No excess payments will be automatically applied to invoices.
                        * Any positive value: Specifies the maximum amount of excess payments that can be automatically applied to a single invoice for this subscription.
                      minimum: -1
                      example: null
                    max_refundable_credits_usage:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Maximum amount of [refundable credits](/docs/api/customers/customer-object#refundable_credits) that can be automatically applied to a single invoice associated with this subscription.

                        **Supported values:**

                        * `-1`: Set to `-1` to reset the subscription-level limit. In this case, the site-level configuration will apply, whether it is configured to Auto Apply or Do Not Auto Apply refundable credits.
                        * `0`: Disable auto-application for the subscription. No refundable credits will be automatically applied to invoices.
                        * Any positive value: Specifies the maximum amount of refundable credits that can be automatically applied to a single invoice for this subscription.
                      minimum: -1
                      example: null
                  example: null
                subscription_items:
                  type: object
                  deprecated: false
                  description: "The list of item prices to add or update in the subscription.\
                    \  \n**Note**\nSee `replace_items_list` for more details.\n"
                  properties:
                    item_price_id:
                      type: array
                      description: "The unique identifier of the item price to add\
                        \ or update in the subscription.  \n**Constraints**\n\n* The\
                        \ [item price currency](item_prices#currency_code) must match\
                        \ the [subscription's currency](subscriptions#currency_code).\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: "The quantity of the item price purchased.  \n\
                        **Prerequisites**\n\n* The item price `pricing_model` must\
                        \ be `per_unit`, `stairstep`, or `tiered`.\n"
                      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 item purchased.  \n**Prerequisites**\n\n* The item price\
                        \ `pricing_model` must be `per_unit`, `stairstep`, or `tiered`.\n\
                        * [Multi-decimal pricing](getting-started) must be enabled.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: "The price or per-unit price of the item. Overrides\
                        \ the price set for the item price.  \n**Prerequisites**\n\
                        \n* The `pricing_model` of the item price must be `flat_fee`\
                        \ or `per_unit`.\n* [Price overriding](https://www.chargebee.com/docs/price-override.html)\
                        \ must be enabled for the site.  \n**Default value**\n\n*\
                        \ The value set for the [item price](item_prices/item-price-object)\
                        \ is used when not provided.\n* If `changes_scheduled_at`\
                        \ is in the past and `unit_price` is not passed, the item\
                        \ price's current unit price is considered even if the item\
                        \ price did not exist on the date.\n"
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: "The decimal representation of the price or per-unit\
                        \ price of the item. Overrides the price set for the item\
                        \ price.  \n**Prerequisites**\n\n* [Price overriding](https://www.chargebee.com/docs/price-override.html)\
                        \ must be enabled for the site.\n* [Multi-decimal pricing](getting-started)\
                        \ must be enabled.  \n**Default value**\n\n* The [value set\
                        \ for the item price](item_prices/item_price-object#price)\
                        \ is used when not provided.\n* If `changes_scheduled_at`\
                        \ is in the past and `unit_price_in_decimal` is not passed,\
                        \ the item price's current unit price is considered even if\
                        \ the item price did not exist on the date.  \n**Constraints**\n\
                        \n* Provide the value as a decimal string in major units of\
                        \ the currency.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: "For plan-item prices: The number of billing cycles\
                        \ the subscription runs before canceling automatically.\n\n\
                        For addon-item prices: The number of subscription billing\
                        \ cycles for which the addon is included. Only applicable\
                        \ when [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)\
                        \ are enabled.  \n**Default value**\n\n* For plan-item prices:\
                        \ The value set for the [item price](item_prices/item-price-object)\
                        \ is used.\n* For addon-item prices: The value set under [attached\
                        \ addons](attached_items/attached-item-object) is used. If\
                        \ that value is not provided, the value set for the [item\
                        \ price](item_prices/item-price-object) is used.\n"
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    trial_end:
                      type: array
                      description: |
                        The date/time when the trial period of the item ends. Applies to plan-items and--when [enabled](https://www.chargebee.com/docs/2.0/addons-trial.html)
                        --addon-items as well.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    service_period_days:
                      type: array
                      description: |
                        The service period of the item in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 730
                        minimum: 1
                        example: null
                      example: null
                    charge_on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          When `charge_on_option`
                          option is set to `on_event`
                          , this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.

                          * contract_termination -
                            when a contract term is [terminated](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option)
                            .
                          * subscription_trial_start - the time when the trial period of the subscription begins.
                          * subscription_activation -
                            the moment a subscription enters an `active`
                            or `non-renewing`
                            state. Also includes reactivations of canceled subscriptions.
                          * plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                          * subscription_creation - the time of creation of the subscription.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        Indicates if the charge-item is to be charged only once or each time the `charge_on_event`
                        occurs. This parameter only applies to charge-items.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    charge_on_option:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates when the charge-item is to be charged. This parameter only applies to charge-items.

                          * immediately - The item is charged immediately on being added to the subscription.
                          * on_event -
                            The item is charged at the occurrence of the event specified as `charge_on_event`
                            .
                        enum:
                        - immediately
                        - on_event
                        example: null
                      example: null
                    description:
                      type: array
                      description: "**Limited availability**\n\nSubscription-level\
                        \ item descriptions are available only on sites where this\
                        \ feature is enabled. Please reach out to the 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\nA description for this item that\
                        \ applies only to this subscription. When set, it is used\
                        \ on the customer-facing invoice instead of the description\
                        \ configured for the item price, and is returned as `entity_description`\
                        \ on the invoice [line item](/docs/api/invoices/invoice-object#invoice_line_items).\n\
                        \nOmit this parameter to retain the description currently\
                        \ stored for the item. Pass an empty value to remove it, after\
                        \ which the description configured for the item price is used.\
                        \  \n**Constraints**\n\n* Maximum 500 characters.\n* Whether\
                        \ a description is shown on the invoice at all continues to\
                        \ be controlled by the item price's [show_description_in_invoices](/docs/api/item_prices#show_description_in_invoices)\
                        \ setting. This parameter determines which description is\
                        \ shown, not whether one is shown.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 500
                        example: null
                      example: null
                    proration_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: "Specifies how to manage charges or credits for\
                          \ the addon item price during this subscription update.\
                          \  \n**Prerequisites**\n\n* The item price must have `item_type`\
                          \ = `addon`.\n* The item price must have `pricing_model`\
                          \ = `per_unit`.\n* The change to the subscription must take\
                          \ effect [immediately](subscriptions/update-subscription-for-items#change_option).\
                          \  \n**Default value**\n\n* If you don't provide a value,\
                          \ Chargebee determines the proration logic based on the\
                          \ following precedence: this parameter \\> [`prorate`](subscriptions/update-subscription-for-items#prorate)\
                          \ parameter \\> [`item_price.proration_type`](item_prices/item_price-object#proration_type)\
                          \ \\> [site-wide proration](https://www.chargebee.com/docs/2.0/proration.html#proration-for-subscription-change)\
                          \ setting.  \n**Constraints**\n\n* Once set, this parameter\
                          \ is saved as part of the [`subscription.subscription_items`](subscriptions/subscription-object#subscription_items)\
                          \ attributes and automatically applies to any additional\
                          \ changes to the addon during the current term. It's removed\
                          \ from the subscription attributes at the next term renewal.\
                          \ You can't alter this parameter's value within the current\
                          \ term via later API calls.\n\n* none - Don't apply any\
                          \ charges or credits for the addon.\n* full_term - Charge\
                          \ the full price of the addon or give the full credit. Don't\
                          \ apply any proration.\n* partial_term - Prorate the charges\
                          \ or credits for the rest of the current term.\n"
                        enum:
                        - full_term
                        - partial_term
                        - none
                        example: null
                      example: null
                    usage_accumulation_reset_frequency:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Specifies the frequency at which the usage counter needs to be reset.

                          * subscription_billing_frequency - Accumulates usage until the subscription's billing frequency ends.
                          * never - Accumulates usage without ever resetting it.
                        enum:
                        - never
                        - subscription_billing_frequency
                        example: null
                      example: null
                  required:
                  - item_price_id
                  example: null
                discounts:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for discounts
                  properties:
                    apply_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The amount on the invoice to which the discount is applied.

                          * invoice_amount -
                            The discount is applied to the invoice `sub_total`
                            .
                          * specific_item_price -
                            The discount is applied to the `invoice.line_item.amount`
                            that corresponds to the item price specified by `item_price_id`
                            .
                        enum:
                        - invoice_amount
                        - specific_item_price
                        example: null
                      example: null
                    duration_type:
                      type: array
                      items:
                        type: string
                        default: forever
                        deprecated: false
                        description: |
                          Specifies the time duration for which this discount is attached to the subscription.

                          * 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 `period`
                            and `period_unit`
                            .
                          * forever -
                            The discount is attached to the subscription and applied on the invoices till it is [explicitly removed](/docs/api/subscriptions/update-subscription-for-items#discounts_operation_type)
                            .
                          * one_time -
                            The discount stays attached to the subscription till it is applied on an invoice **once**.
                            It is removed after that from the subscription.
                        enum:
                        - one_time
                        - forever
                        - limited_period
                        example: null
                      example: null
                    percentage:
                      type: array
                      description: |
                        The percentage of the original amount that should be deducted from it.
                      items:
                        type: number
                        format: double
                        deprecated: false
                        maximum: 100
                        minimum: 0.01
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        The value of the discount. [The format of this value](/docs/api/currencies)
                        depends on the kind of currency.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    period:
                      type: array
                      description: |
                        The duration of time for which the discount is attached to the subscription, in `period_units`.
                        Applicable only when `duration_type`
                        is `limited_period`.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    period_unit:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The unit of time for `period`.
                          Applicable only when `duration_type`
                          is `limited_period`.

                          * week - A period of 7 days.
                          * year - A period of 1 calendar year.
                          * day - A period of 24 hours.
                          * month - A period of 1 calendar month.
                        enum:
                        - day
                        - week
                        - month
                        - year
                        example: null
                      example: null
                    included_in_mrr:
                      type: array
                      description: |
                        The discount is included in MRR calculations for your site. This attribute is only applicable when `duration_type`
                        is `one_time`
                        and when the [feature is enabled](https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation)
                        in Chargebee. Also, If the [site-level setting](https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation)
                        is to exclude one-time discounts from MRR calculations, this value is always returned `false`.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    item_price_id:
                      type: array
                      description: |
                        The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                        in the subscription to which the discount is to be applied. Relevant only when `apply_on`
                        = `specific_item_price`.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Specifies the number of free units provided for the item, without affecting the total quantity sold
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    operation_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The operation to be carried out for the discount.

                          * remove -
                            The discount (given by `discounts[id]`
                            ) is removed from the subscription. Subsequent invoices will no longer have the discount applied. **Tip:**
                            If you want to replace a discount, `remove`
                            it and `add`
                            another in the same API call.
                          * add - The discount is attached to the subscription.
                        enum:
                        - add
                        - remove
                        example: null
                      example: null
                    id:
                      type: array
                      description: |
                        The `id`
                        of the `discount`
                        to be removed. This parameter is only relevant when `discounts[operation_type]`
                        is `remove`
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  required:
                  - duration_type
                  - operation_type
                  example: null
                item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_tiers
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The id of the item price for which the tier price is being overridden.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: |
                        The lowest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The highest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |
                        The overridden price of the tier. The value depends on the [type of currency](/docs/api/subscriptions)
                        .
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    pricing_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Pricing type for the tier.

                          * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                          * flat_fee -
                            Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                            pricing model, `pricing_type`
                            will be set to `flat_fee`
                            by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                          * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                        enum:
                        - per_unit
                        - flat_fee
                        - package
                        example: null
                      example: null
                    package_size:
                      type: array
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              billing_address:
                style: deepObject
                explode: true
              billing_override:
                style: deepObject
                explode: true
              card:
                style: deepObject
                explode: true
              contract_term:
                style: deepObject
                explode: true
              customer:
                style: deepObject
                explode: true
              discounts:
                style: deepObject
                explode: true
              item_tiers:
                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
              subscription_items:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                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
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: |
                      Resource object representing invoice
                  unbilled_charges:
                    type: array
                    description: |
                      Resource object representing unbilled_charge
                    items:
                      $ref: "#/components/schemas/UnbilledCharge"
                      description: Resource object representing unbilled_charge
                    example: null
                  credit_notes:
                    type: array
                    description: |
                      Resource object representing credit_note
                    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}/remove_coupons:
    post:
      tags:
      - subscriptions
      summary: Remove coupons
      description: |
        **Caution**
        If there are scheduled [ramps](/docs/api/ramps) for the subscription, this operation can move the ramps to the [draft](/docs/api/ramps/ramp-object#status) status when it conflicts with any upcoming ramps.

        Removes coupons associated with the subscription. If the param `coupon_ids`
        is not specified, all the coupons linked to the subscription are 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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      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
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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:
      tags:
      - subscriptions
      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 you specify **schedule_payment_collection** , Chargebee will try to collect payments for overdue invoices, provided that `auto_collection` is enabled for the subscription. The available payment method is charged. Upon successful payment, the `payment_succeeded` event is triggered. If the payment collection fails, no further attempts will be made to collect payment 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.

        **Warning**

        This API will return an error when [multi-frequency billing](/docs/api/subscriptions) is enabled.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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.

                        * alipay_hk - Payments made via Alipay HK.
                        * card - card
                        * twint - Payments made via Twint
                        * swish - Payments made via Swish
                        * after_pay - Payments made via Afterpay
                        * netbanking_emandates - netbanking_emandates
                        * nequi - Payments made via Nequi.
                        * grab_pay - Payments made via GrabPay
                        * paypay - PayPay
                        * payconiq_by_bancontact - Payments made via Payconiq by Bancontact.
                        * dotpay - dotpay
                        * mercado_pago - Payments made via Mercado Pago.
                        * faster_payments - Faster Payments
                        * p24 - Payments made via Przelewy24 (P24).
                        * upi - upi
                        * kbc_payment_button - KBC Payment Button
                        * electronic_payment_standard - Electronic Payment Standard
                        * klarna - Payments made via Klarna.
                        * payme - Payments made via PayMe
                        * direct_debit - direct_debit
                        * sepa_instant_transfer - Sepa Instant Transfer
                        * bancontact - bancontact
                        * thai_qr - Payments made via Thai QR.
                        * go_pay - Payments made via GoPay
                        * wero - Payments made via Wero.
                        * pay_by_bank - Pay By Bank
                        * touch_n_go - Payments made via Touch 'n Go.
                        * google_pay - google_pay
                        * apple_pay - apple_pay
                        * qpay - Payments made via Qpay.
                        * online_banking_poland - Online Banking Poland
                        * trustly - Trustly
                        * gcash - Payments made via GCash.
                        * naver_pay - Payments made via Naver Pay.
                        * nupay - Payments made via NuPay.
                        * stablecoin - Payments made via Stablecoin.
                        * giropay - giropay
                        * paypal_express_checkout - paypal_express_checkout
                        * pix - Pix
                        * venmo - Venmo
                        * klarna_pay_now - Klarna Pay Now
                        * momo - Payments made via MoMo.
                        * alipay - Payments made via Alipay.
                        * sofort - sofort
                        * amazon_payments - Amazon Payments
                        * affirm_pay - Payments made via Affirm Pay.
                        * tamara - Payments made via Tamara.
                        * ideal - ideal
                        * kakao_pay - Payments made via Kakao Pay.
                        * picpay - Payments made via PicPay.
                        * fpx - Payments made via FPX.
                        * blik - Payments made via BLIK.
                        * pay_to - PayTo
                        * ovo - Payments made via OVO.
                        * dana - Payments made via Dana.
                        * south_korean_cards - Payments made via South Korean Cards
                        * 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.
                        * rakuten_pay - Payments made via Rakuten 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
                      - alipay_hk
                      - paypay
                      - gcash
                      - south_korean_cards
                      - paynow
                      - bizum
                      - promptpay
                      - dana
                      - touch_n_go
                      - tamara
                      - qpay
                      - ovo
                      - momo
                      - mercado_pago
                      - nequi
                      - nupay
                      - picpay
                      - thai_qr
                      - blik
                      - fpx
                      - wero
                      - p24
                      - affirm_pay
                      - rakuten_pay
                      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: |
                        * `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal).

                          * `payer`: User related information.
                            * `country_of_residence`: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a [two-character ISO code](https://docs.checkout.com/resources/codes/country-codes).
                            * `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
                        * `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
                        * `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user's `device_session_id` can be added to perform [additional validation](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                            * `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
                        * `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
                        * `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                        * `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.

                          * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
                        * `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.

                          * `payer`: User related information.
                            * `document`: Document is the user's identification number based on their country.
                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device
                      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: |
                      Resource object representing subscription
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: |
                      Resource object representing customer
                  card:
                    $ref: "#/components/schemas/Card"
                    description: |
                      Resource object representing card
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: |
                      Resource object representing invoice
                  unbilled_charges:
                    type: array
                    description: |
                      Resource object representing unbilled_charge
                    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}/cancel_for_items:
    post:
      tags:
      - subscriptions
      summary: Cancel a subscription
      description: "Cancels the specified subscription.  \n\n### Prerequisites \\\
        & Constraints\n\n* The subscription [status](/docs/api/subscriptions/subscription-object#status)\
        \ must not be `cancelled` or `transferred`.\n* If the subscription has a [contract\
        \ term](/docs/api/contract_terms), specify [`contract_term_cancel_option`](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option)\
        \ instead of [`cancel_option`](/docs/api/subscriptions/cancel-subscription-for-items#cancel_option).\
        \  \n\n### Impacts\n\n**Subscription**  \n* The cancellation date-time depends\
        \ on the provided parameters:\n  * When the subscription does not have a contract\
        \ term, use `cancel_option`.\n  * When the subscription has a contract term,\
        \ use `contract_term_cancel_option`.\n* The subscription `status` changes\
        \ to `cancelled` when canceled.\n* If `cancel_option` is specified as `end_of_term`,\
        \ or if `contract_term_cancel_option` is specified as `end_of_subscription_billing_term`,\
        \ the subscription `status` changes to `non_renewing` and the subscription\
        \ `billing_cycles` becomes `0`.  \n**Contract Terms**  \n* The contract term\
        \ and subscription are canceled together based on the provided `contract_term_cancel_option`.\
        \  \n**Ramps**  \nIf [ramps](/docs/api/ramps) are scheduled for the subscription,\
        \ this operation deletes any ramps that are set to become effective on or\
        \ after the subscription's cancellation date-time.  \n\n### Implementation\
        \ Notes\n\nBefore calling this API, perform the following checks:\n\n* Confirm\
        \ that the subscription `status` is not `cancelled` or `transferred`.\n* If\
        \ the subscription has a contract term, pass `contract_term_cancel_option`\
        \ instead of `cancel_option`.  \n\n### Use Cases\n\nCancel a subscription\
        \ with a [contract term](/docs/api/contract_terms)  \nIf the subscription\
        \ has a contract term, you can use the following parameters with this API:\n\
        \n* `contract_term_cancel_option`\n* `cancel_at`\n* `credit_option_for_current_term_charges`\n\
        * `unbilled_charges_option`\n* `account_receivables_handling`\n* `refundable_credits_handling`\n"
      operationId: cancel_subscription_for_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    ##### If the subscription does not have a contract term:

                    Determines when to cancel the subscription.

                    ##### If the subscription has a contract term:

                    This parameter is not applicable.

                    * end_of_billing_term - This is used to cancel a subscription either at the end of the advance term, if it's billed for future renewals or at the end of its current billing cycle
                    * end_of_term - This is used to cancel a subscription at the end of the current billing cycle
                    * immediately - This is used to cancel the subscription with immediate effect
                    * specific_date - This is used to cancel a subscription on a specified date. The change occurs as of the date/time defined in `cancel_at`
                  enum:
                  - immediately
                  - end_of_term
                  - specific_date
                  - end_of_billing_term
                  example: null
                end_of_term:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    **(Deprecated)** Use `cancel_option` instead.
                    Applicable only when the subscription does not have [contract terms](/docs/api/contract_terms).
                    Set this to `true` if you want to cancel the subscription at the end of the current subscription billing cycle. The subscription `status` changes to `non_renewing`.
                  example: null
                cancel_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    ##### If the subscription does not have a contract term:

                    Specifies the date and time when the subscription should be canceled. Do not use this parameter when `end_of_term` is set to `true`.

                    ##### If the subscription has a contract term:

                    Applicable only when `contract_term_cancel_option` is `specific_date`. Specifies the date and time to cancel the subscription and contract term.

                    ##### Backdating

                    You can set a past date to backdate the cancellation. Backdating is allowed only if the following conditions are met:

                    * [Backdating](https://www.chargebee.com/docs/2.0/backdating.html) is enabled for subscription cancellation.
                    * The current date does not exceed the [backdating limit configured in Chargebee Billing](https://www.chargebee.com/docs/2.0/backdating.html#configuring-backdated-subscription-actions-and-invoicing).
                    * The date is on or after the `current_term_start`.
                    * The date is on or after the most recent change involving:
                      * Addition/change/removal of plan or addon item prices.
                      * Addition of charge item prices.
                    * The date is not more than one billing period into the past. For example, if the plan's billing period is two months and today is April 14, `cancel_at` cannot be earlier than February 14.
                  example: null
                credit_option_for_current_term_charges:
                  type: string
                  deprecated: false
                  description: |
                    ##### If the subscription does not have a contract term:

                    Specifies how to handle credits for current term charges when canceling immediately (i.e., `cancel_option` is `immediately`). If not specified, the [site-level setting](https://www.chargebee.com/docs/2.0/cancellations.html#configure-subscription-cancellation) is used.

                    ##### If the subscription has a contract term:

                    Specifies how to handle credits for current term charges when `contract_term_cancel_option` is `terminate_immediately`. If not specified, the [site-level setting](https://www.chargebee.com/docs/2.0/contract-terms.html#configuring-contract-terms) is used.

                    * none - No credits notes are created.
                    * full - Credits are issues for the full value of the current term charges.
                    * prorate - Prorated credits are issued.
                  enum:
                  - none
                  - prorate
                  - full
                  - consumption_based
                  example: null
                unbilled_charges_option:
                  type: string
                  deprecated: false
                  description: |
                    ##### If the subscription does not have a contract term:

                    Specifies how to handle unbilled charges when canceling immediately (i.e., `cancel_option` is `immediately`). If not specified, the [site-level setting](https://www.chargebee.com/docs/2.0/cancellations.html#configure-subscription-cancellation) is used.

                    ##### If the subscription has a contract term:

                    Specifies how to handle unbilled charges when `contract_term_cancel_option` is `terminate_immediately`. If not specified, the [site-level setting](https://www.chargebee.com/docs/2.0/contract-terms.html#configuring-contract-terms) is used.

                    * invoice - An invoice is generated immediately with the unbilled charges.
                    * delete - The unbilled charges are deleted.
                  enum:
                  - invoice
                  - delete
                  example: null
                account_receivables_handling:
                  type: string
                  deprecated: false
                  description: |
                    ##### If the subscription does not have a contract term:

                    Specifies how to handle past due invoices when canceling immediately (i.e., `cancel_option` is `immediately`). If not specified, the [site-level setting](https://www.chargebee.com/docs/2.0/cancellations.html#configure-subscription-cancellation) is used.

                    ##### If the subscription has a contract term:

                    Specifies how to handle past due invoices when `contract_term_cancel_option` is `terminate_immediately`. If not specified, the [site-level setting](https://www.chargebee.com/docs/2.0/contract-terms.html#configuring-contract-terms) is used.

                    * no_action - No action is taken.
                    * write_off -
                      Applies excess payments and refundable credits to past due invoices. Any remaining balance is written off.

                      *Note: The credit note for the write-off is not included in the API response.*
                    * schedule_payment_collection -
                      Applies excess payments and refundable credits to past due invoices. If any amount remains and `auto_collection`
                      is `on`
                      , the remaining amount is automatically charged to the available payment method.
                  enum:
                  - no_action
                  - schedule_payment_collection
                  - write_off
                  example: null
                refundable_credits_handling:
                  type: string
                  deprecated: false
                  description: |
                    ##### If the subscription does not have a contract term:

                    Specifies how to handle refundable credits when canceling immediately (i.e., `cancel_option` is `immediately`). If not specified, the [site-level setting](https://www.chargebee.com/docs/2.0/cancellations.html#configure-subscription-cancellation) is used.

                    ##### If the subscription has a contract term:

                    Specifies how to handle refundable credits when `contract_term_cancel_option` is `terminate_immediately`. If not specified, the [site-level setting](https://www.chargebee.com/docs/2.0/contract-terms.html#configuring-contract-terms) is used.

                    * schedule_refund - Refunds remaining credits after applying them to any past due invoices.
                    * no_action - No action is taken.
                  enum:
                  - no_action
                  - schedule_refund
                  example: null
                contract_term_cancel_option:
                  type: string
                  deprecated: false
                  description: |
                    Required when the subscription has a contract term. Determines when to cancel the subscription along with the contract term.

                    * terminate_immediately -
                      Cancels the subscription and contract term immediately. Sets the contract term's `status` to `terminated` and collects any termination fee, if applicable.

                      To specify the termination fee, include a single object in the `subscription_items` array. If not specified, the [default termination fee](/docs/api/contract_terms) is applied (if configured).
                    * end_of_contract_term - Prevents the contract term from renewing and schedules the subscription for cancellation at the end of the contract term.
                    * specific_date -
                      Cancels the subscription and contract term on the date specified by `cancel_at`. Sets `action_at_term_end` to `cancel`.

                      **Note** : 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) to enable this option for your [Chargebee site](https://www.chargebee.com/docs/2.0/sites-intro.html).
                    * end_of_subscription_billing_term -
                      Cancels the subscription and contract term at the end of the current billing cycle. Sets `action_at_term_end` to `cancel`.

                      **Note** : 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) to enable this option for your [Chargebee site](https://www.chargebee.com/docs/2.0/sites-intro.html).
                  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: |
                    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 `create_pending_invoices`
                    is `true`
                    , 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 `invoice_date`.
                    When passing this parameter, the following prerequisites must be met:

                    * `invoice_date` must be in the past.
                    * `invoice_date` 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.
                    * It is not earlier than `cancel_at`. .
                  example: null
                include_cancellation_day_in_billing:
                  type: boolean
                  deprecated: false
                  description: |
                    Determines whether the cancellation day is included in the billing period when prorated credits are issued for the current term charges.
                    Set to `true` to bill the customer for the cancellation day (the term ends on the cancellation date), or `false` to exclude it (the term ends the day before). If not specified, the [site-level setting](https://www.chargebee.com/docs/2.0/cancellations.html#configure-subscription-cancellation) is used.
                    This parameter is applicable only for sites using Day-Based Billing, when:

                    * the subscription is `active` or `non_renewing`,
                    * the subscription is canceled immediately, on a backdated date, or on a specific date within the current term, and
                    * `credit_option_for_current_term_charges` is set to `prorate`.

                    **Note**: Passing this parameter in any other scenario results in a validation error.
                  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
                decommissioned:
                  type: boolean
                  default: false
                  deprecated: false
                  description: "Indicates whether the subscription should be decommissioned\
                    \ when it is canceled. If set to `true` all subscription operations\
                    \ will be disabled except deletion.  \n**Note** : Decommission\
                    \ operation is irreversible. Once set to `true` it cannot be updated\
                    \ to `false` and thus subscription will remain decommissioned\
                    \ permanently.\n"
                  example: null
                subscription_items:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription_items
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The unique `id`
                        of the charge item_price that represents the termination fee.
                      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 item_price for the termination charge is quantity-based.
                      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 item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        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
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](https://www.chargebee.com/docs/2.0/price-override.html)
                        is enabled for the site, the price or per-unit price of the item can be set here. The [value set for the item price](/docs/api/item_prices/item_price-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/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    service_period_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: 730
                        minimum: 1
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              subscription_items:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                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
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: |
                      Resource object representing invoice
                  unbilled_charges:
                    type: array
                    description: |
                      Resource object representing unbilled_charge
                    items:
                      $ref: "#/components/schemas/UnbilledCharge"
                      description: Resource object representing unbilled_charge
                    example: null
                  credit_notes:
                    type: array
                    description: |
                      Resource object representing credit_note
                    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}/regenerate_invoice:
    post:
      tags:
      - subscriptions
      summary: Regenerate an invoice
      description: "Use this API to regenerate the current-term [invoice](/docs/api/invoices)\
        \ for a subscription. The new invoice will contain non-metered charges from\
        \ the current term and [metered](/docs/api/items/item-object#metered) charges\
        \ from the previous term.\nIf a customer was billed incorrectly, because of\
        \ a wrong plan, price, or tax configuration, you can first [void](/docs/api/invoices/void-an-invoice)\
        \ or [delete](/docs/api/invoices/delete-an-invoice) the erroneous invoice,\
        \ update the [subscription](/docs/api/subscriptions/update-subscription-for-items)\
        \ or [usage](/docs/api/usages/create-a-usage) records, and then run this operation\
        \ to issue the corrected invoice.  \n\n### Prerequisites \\& Constraints\n\
        \nBefore regenerating an invoice, ensure the following conditions are met:\n\
        \n* The subscription's current-term invoice must be voided or deleted.\n*\
        \ The subscription [`status`](/docs/api/subscriptions/subscription-object#status)\
        \ must be `active` or `non_renewing`.\n* There should be no [unbilled charges](/docs/api/unbilled_charges)\
        \ for non-`metered` subscribed items for the current term.\n* There should\
        \ be no unbilled charges for `metered` items for the previous term.\n* The\
        \ subscription must not have any [advance invoices](https://www.chargebee.com/docs/2.0/advance-invoices.html#generating-an-advance-invoice)\
        \  \n\n### Impacts\n\n**Current-Term Invoice**  \nChargebee does not modify\
        \ the voided or deleted invoice for the current term. Instead, it creates\
        \ a new invoice.\n\nThe new invoice includes:\n\n* Subscription-item charges\
        \ for the current term.\n* Usage charges from the previous term.\n\nThe new\
        \ invoice **does not** include:\n\n* One-time addon charges, including mandatory\
        \ addons.\n* Ad hoc or other one-time charges from the voided or deleted invoice.\n\
        * Unbilled charges.\n* Usage charges for the current term.\n\nIf every charge\
        \ for the current-term has a value of zero, and your site is configured to\
        \ [hide zero-value line items](https://www.chargebee.com/docs/billing/2.0/kb/billing/how-to-hide-zero-value-line-items-from-my-customers),\
        \ the invoice is not generated.\n\nIf you delete the original invoice, the\
        \ associated usage data is also deleted. To ensure accurate billing for metered\
        \ items, [add](/docs/api/usages/create-a-usage) or [bulk import](https://www.chargebee.com/docs/2.0/bulk-operations.html#overview_available-bulk-operations)\
        \ usage records before regenerating the invoice.  \n**Payment Collection**\
        \  \nIf [`auto-collection`](/docs/api/customers/customer-object#auto_collection)\
        \ is `on`, Chargebee attempts to collect payment for the regenerated invoice.\
        \ If the payment collection **fails** , the invoice regeneration also **fails**.\n\
        \n**Note** : Chargebee applies any [customer balances](/docs/api/customers/customer-object#balances),\
        \ such as unapplied payment from the voided invoice, before attempting to\
        \ collect the remaining amount.  \n**Order**  \nAny [orders](/docs/api/orders)\
        \ associated with the invoice are regenerated automatically when the invoice\
        \ is regenerated.  \n\n### Implementation Notes\n\nBefore calling this API,\
        \ perform the following checks:\n\n* Confirm that the subscription `status`\
        \ is `active` or `non_renewing`.\n* The invoice regeneration is supported\
        \ for the current term only. If you're using the `date_from` and `date_to`\
        \ parameters, ensure that their values fall within the range defined by [`subscription.current_term_start`](/docs/api/subscriptions/subscription-object#current_term_start)\
        \ and [`subscription.current_term_end`](/docs/api/subscriptions/subscription-object#current_term_end).\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    Whether the charges should be prorated according to the term specified by `date_from`
                    and `date_to`.
                    Should not be passed without `date_from`
                    and `date_to`
                    .
                  example: null
                invoice_immediately:
                  type: boolean
                  deprecated: false
                  description: |
                    Only applicable when [Consolidated Invoicing](https://www.chargebee.com/docs/consolidated-invoicing.html )
                    is enabled for the customer. Set to `false`
                    to leave the current term charge for the subscription as [unbilled](https://www.chargebee.com/docs/unbilled-charges.html ).
                    Once you have done this for all suitable subscriptions of the customer, call [Create an invoice for unbilled charges](/docs/api/unbilled_charges/create-an-invoice-for-unbilled-charges)
                    to invoice them.
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: |
                      Resource object representing invoice
                  unbilled_charges:
                    type: array
                    description: |
                      Resource object representing unbilled_charge
                    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:
      tags:
      - subscriptions
      summary: List subscriptions
      description: |
        Returns a list of subscriptions meeting **all**
        the conditions specified in the filter parameters below.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: include_deleted
        in: query
        description: |
          Indicates whether to include deleted objects in the list. The deleted objects have the attribute `deleted`
          as `true`
          .
        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_not\] = "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: item_id
        in: query
        description: |
          optional, string filter

          The plan item code.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

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

          The plan item price code.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *item_price_id\[is\] = "silver-USD-monthly"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: silver-USD-monthly
          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_not\] = "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 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\[is_not\] = "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\[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: activated_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          Time at which the subscription `status`
          last changed to
          `active`.
          For example, this value is updated when an `in_trial`
          or
          `cancelled`
          subscription activates.
          **Supported operators :**
          after, before, on, between, is_present

          **Example →**
          *activated_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
            is_present:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
      - name: next_billing_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          The date/time at which the next billing for the subscription happens. This is usually right after `current_term_end`
          unless multiple subscription terms were invoiced in advance using the `terms_to_charge`
          parameter.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *next_billing_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: 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\[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: has_scheduled_changes
        in: query
        description: |
          optional, boolean filter

          If `true`
          , there are subscription changes scheduled on next renewal. Possible values are : *true, false*

          **Supported operators :**
          is

          **Example →**
          *has_scheduled_changes\[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: 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. It is advisable when using this filter, to pass the `sort_by`
          input parameter as `updated_at`
          for a faster response.
          **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: 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_not\] = "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

          Set to `false`
          to override for this subscription, the [site-level setting](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing)
          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 [customer level](/docs/api/customers/customer-object#auto_close_invoices).
          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: override_relationship
        in: query
        description: |
          optional, boolean filter

          If `true`
          , ignores the [hierarchy relationship](/docs/api/customers/customer-object#relationship)
          and uses customer as payment and invoice owner. Possible values are : *true, false*

          **Supported operators :**
          is

          **Example →**
          *override_relationship\[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: 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

          The unique ID of the
          [business entity](/docs/api/advanced-features)
          of this subscription. This is always the same as the
          [business entity](/docs/api/subscriptions/subscription-object#customer_id)
          of the customer.

          **Supported operators :**
          is, is_not, starts_with

          **Example →**
          *business_entity_id\[is_not\] = "business_entity_id"*
        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.\n* `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.\n* `play_store` -\n  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.  \n  In-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.\n* `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.\n* `play_store` -\n  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.  \n  In-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.\n* `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.\n* `play_store` -\n  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.  \n  In-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.\n* `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.\n* `play_store` -\n  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.  \n  In-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: decommissioned
        in: query
        description: |
          optional, boolean filter

          Filter subscriptions based on whether they have been [decommissioned](/docs/api/subscriptions/subscription-object#decommissioned).

          **Example →**
          `decommissioned[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
      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: []
  /subscriptions/{subscription-id}/move:
    post:
      tags:
      - subscriptions
      summary: Move a subscription
      description: "Moves a subscription from one [customer](/docs/api/customers)\
        \ to another asynchronously. All related resources such as [unbilled_charge](/docs/api/unbilled_charges),\
        \ [invoice](/docs/api/invoices), [credit_note](/docs/api/credit_notes), and\
        \ [transaction](/docs/api/transactions) are also moved to the new customer.\n\
        \nAfter moving, Chargebee adds a [comment](/docs/api/comments) to the original\
        \ `customer` resource to document the move, including the [to_customer_id](/docs/api/subscriptions/move-a-subscription#to_customer_id)\
        \ and the `id`s of all the resources transferred to the destination customer.\
        \  \n**Warning**\n\n* If [auto_collection](/docs/api/subscriptions/create-subscription-for-items#auto_collection)\
        \ is `on`, it might fail after this operation. Refer to the warning in [copy_payment_source](/docs/api/subscriptions/move-a-subscription#copy_payment_source)\
        \ for details.\n* 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.\n* After moving a subscription, the change does not\
        \ reflect in Chargebee Billing's [accounting integrations](https://www.chargebee.com/docs/2.0/finance-integration-index.html)\
        \ or in [Chargebee RevRec](https://www.chargebee.com/docs/revrec/chargebee-billing-features.html).\n\
        * This API will return an error when [multi-frequency billing](/docs/api/subscriptions)\
        \ is enabled.\n\n#### Prerequisites\n\n* The subscription should not be part\
        \ of a `customer` resource that is within an account hierarchy [relationship](/docs/api/customers/customer-object#relationship).\n\
        * There must be no invoices with the [statuses](/docs/api/invoices/invoice-object#status)\
        \ `payment_due`, `pending`, or `posted` associated with the subscription.\n\
        * The site must have [consolidated invoicing](https://www.chargebee.com/docs/2.0/consolidated-invoicing.html)\
        \ disabled.\n* There should be no consolidated invoices linked to the subscription.\n\
        * No `credit_note` resources with the [statuses](/docs/api/credit_notes/credit_note-object#status)\
        \ `adjusted` or `refund_due` should be associated with the subscription.\n\
        * With muti business entity (MBE) enabled on your site, moving a subscription\
        \ to a customer belonging to another business entity is not allowed.\n\n####\
        \ Asynchronous operation\n\nIf the above prerequisites are met, the API call\
        \ returns a `200 OK` response containing the `subscription` resource as is.\
        \ However, the actual move operation can take up to **five** minutes to complete.\n\
        \nTo know whether the operation was successful, we recommend that you watch\
        \ for the [subscription_changed](/docs/api/events) event and see if `subscription.customer_id`\
        \ has changed.\n\n#### Limitations\n\n* 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.\n* After moving a subscription,\
        \ the change does not reflect in Chargebee Billing's [accounting integrations](https://www.chargebee.com/docs/2.0/finance-integration-index.html)\
        \ or in [Chargebee RevRec](https://www.chargebee.com/docs/revrec/chargebee-billing-features.html).\n\
        \n**Note** :\nResources linked to the original customer such as `unbilled_charge`\n\
        , `invoice`\n, `credit_note`\n, and `transaction`\nbut **not**\nlinked to\
        \ the subscription being moved, are **not**\nmoved to the destination customer\
        \ by this operation.\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: "Specifies the unique ID of the `customer` resource\
                    \ to which the subscription will be moved.  \n**Note** :\nIf there\
                    \ are [multiple business entities](/docs/api/advanced-features)\n\
                    , the `customer.business_entity_id`\nof the destination customer\
                    \ must match the `subscription.business_entity_id`.\n"
                  maxLength: 50
                  example: null
                copy_payment_source:
                  type: boolean
                  default: false
                  deprecated: false
                  description: "**When `true`:**\nIf the subscription has an [associated\
                    \ `payment_source`](/docs/api/subscriptions/subscription-object#payment_source_id):\n\
                    \n1. A new duplicate copy of the `payment_source` resource is\
                    \ created.\n2. This new copy of the payment source is linked to\
                    \ the subscription and the destination customer.\n\n**Note** :\n\
                    Deleting any copy of the `payment_source`\nalso deletes the other\
                    \ copies and the details stored at the payment gateway.\n\n**When\
                    \ `false`:**\nNo new payment source is created for the subscription.\
                    \ Moreover, if a `payment_source` is already [linked](/docs/api/subscriptions/subscription-object#payment_source_id)\
                    \ to the subscription, it gets removed, meaning the `subscription.payment_source_id`\
                    \ is cleared.  \n**Warning** :\nWhen `copy_payment_source`\nis\
                    \ `false`\nand if [subscription.auto_collection](/docs/api/subscriptions/create-subscription-for-items#auto_collection)\n\
                    is enabled, auto-collection will fail, in turn preventing subscription\
                    \ renewal. To prevent auto-collection failure, [link a payment\
                    \ source](/docs/api/subscriptions/override-billing-profile)\n\
                    to the subscription after this operation.\n"
                  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: |
                      Resource object representing subscription
                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_for_items:
    post:
      tags:
      - customers
      summary: Import a subscription
      description: "Imports a [subscription](/docs/api/subscriptions) for an existing\
        \ [customer](/docs/api/customers).\n\nUse this operation when migrating subscriptions\
        \ from another billing system.  \n\n### Prerequisites \\& Constraints\n\n\
        If you are calling this operation on your live site, ensure you have [requested\
        \ 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 it; otherwise the API may return an \"API not enabled\" error.\
        \  \n\n### Impacts\n\n**Subscription**  \nA subscription is created for the\
        \ customer with the details provided in the request.  \n**Invoice and payment**\
        \  \nWhen `create_current_term_invoice` is `true`, an invoice is created for\
        \ the current term.\n"
      operationId: import_subscription_for_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
                exhausted_coupon_ids:
                  type: array
                  deprecated: false
                  description: |
                    Specifies the IDs of [coupons](/docs/api/coupons)
                    to be marked as exhausted. This parameter accepts a list of IDs, which must correspond to coupons with a [duration_type](/docs/api/coupons/coupon-object#duration_type)
                    of `one_time`.
                    Ensure that the IDs included in this parameter do not match any IDs provided in the [coupon_ids](/docs/api/subscriptions/import-subscription-for-items#coupon_ids)
                    parameter.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                id:
                  type: string
                  deprecated: false
                  description: |
                    A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
                  maxLength: 50
                  example: null
                trial_end:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    End of the trial period for the subscription. This overrides the trial period set for the plan-item. The value must be later than `start_date`.
                    Set it to `0`
                    to have no trial period.
                  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-item price](/docs/api/item_prices/item_price-object#billing_cycles)
                    is used.
                  minimum: 0
                  example: null
                net_term_days:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Defines [Net D](https://www.chargebee.com/docs/net_d.html)
                    for the subscription. Net D is the number of days within which any invoice raised for the subscription must be paid.

                    * If a value is provided: Net D is set explicitly for the subscription to the value provided. The value must be one among those defined in the [site configuration](https://www.chargebee.com/docs/net_d.html#enable-net-d-for-chargebee-invoices).
                    * If not provided: The attribute is not set and therefore not returned by the API. In this case, when an invoice is raised - whether now or later - the `net_term_days` defined at the [customer level](/docs/api/customers/customer-object#net_term_days) is considered. .
                  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: |
                    End of the current billing term. Subscription is renewed immediately after this. If not given, this will be calculated based on plan billing cycle.
                  example: null
                current_term_start:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    Start of the current billing period of the subscription. This is required when the subscription `status`
                    is `paused`.
                    When the `status`
                    is `active`
                    or `non_renewing`
                    , it defaults to the current time.
                  example: null
                trial_start:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    Start of the trial period for the subscription. When not passed, it is assumed to be current time. When passed for a `future`
                    subscription, it implies that the subscription goes into `in_trial`
                    when it starts.
                  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: |
                    Time at which the subscription was started. Is `null`
                    for `future`
                    subscriptions as it is yet to be started.
                  example: null
                activated_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The time at which the subscription was activated. A subscription is "activated" when its `status` changes from any other, to either `active` or `non_renewing`.
                  example: null
                pause_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    When a pause has been scheduled, it is the date/time of scheduled pause. When the subscription is in the `paused`
                    state, it is the date/time when the subscription was paused.
                  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: |
                    Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as `billing_cycles`
                    or a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)
                    .
                  maximum: 100
                  minimum: 1
                  example: null
                create_current_term_invoice:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Set as `true`
                    if you want an invoice to be created for the subscription.

                    * The invoice will be created for the subscription only if it has an `active` or `non_renewing` status.
                    * The period of the invoice is from `current_term_start` to `current_term_end`.
                    * The invoice will not be generated if the subscription amount is zero dollars (for that period) and 'Hide Zero Value Line Items' option is enabled in site settings.
                    * You may pass `transaction` details to record an offline payment against that invoice.
                  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 set of key-value pairs stored as additional information for the subscription. [Learn more](/docs/api/subscriptions)
                    .
                  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
                create_pending_invoices:
                  type: boolean
                  deprecated: false
                  description: |
                    Indicates whether the invoices for this subscription are generated with a `pending` `status`. This attribute is set to `true` automatically when the subscription has item prices that belong to `metered` items.
                    You can also set this to `true` explicitly using the [create](/docs/api/subscriptions/create-subscription-for-items#create_pending_invoices)/[update](/docs/api/subscriptions/update-subscription-for-items#create_pending_invoices) subscription operations. This is useful in the following scenarios:

                    * When tracking usages and calculating usage-based charges on your end. You can then add them to the subscription as a [one-time charge](https://www.chargebee.com/docs/charges.html) at the end of the billing term.
                    * When you need to inspect all charges before closing invoices for this subscription. Applicable only when [Metered Billing](https://www.chargebee.com/docs/metered_billing.html) is enabled for the site .
                  example: null
                auto_close_invoices:
                  type: boolean
                  deprecated: false
                  description: |
                    Set to `false`
                    to override for this subscription, the [site-level setting](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing)
                    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 [customer level](/docs/api/customers/customer-object#auto_close_invoices)
                    .
                  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: |
                        The amount raised for the contract term till the time of importing the subscription. This amount is added to the [total_contract_value](/docs/api/contract_terms/contract_term-object#total_contract_value)
                      minimum: 0
                      example: null
                    total_amount_raised_before_tax:
                      type: integer
                      format: int64
                      default: 0
                      deprecated: false
                      description: |
                        The amount raised for the contract term till the time of importing the subscription excluding tax. This amount is added to the [total_contract_value_before_tax](/docs/api/contract_terms/contract_term-object#total_contract_value)
                      minimum: 0
                      example: null
                    action_at_term_end:
                      type: string
                      default: renew
                      deprecated: false
                      description: |
                        Action to be taken when the contract term completes.

                        * evergreen - Contract term completes and the subscription renews.
                        * renew -
                          * Contract term completes and a new contract term is started for the number of billing cycles specified in [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).
                          * The `action_at_term_end` for the new contract term is set to `renew`.
                        * renew_once -
                          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 [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).

                          * The `action_at_term_end` for the new contract term is set to `cancel`.
                        * cancel - Contract term completes and subscription is canceled.
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      - renew_once
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      default: 0
                      deprecated: false
                      description: |
                        The number of days before [`contract_end`](/docs/api/contract_terms/contract_term-object#contract_end)
                        , 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.
                      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.
                      minimum: 0
                      example: null
                    payment_method:
                      type: string
                      deprecated: false
                      description: |
                        The payment method of this transaction. This parameter should be passed only if the invoice is created for the current term.

                        * cash - Cash
                        * custom - Custom
                        * check - Check
                        * bank_transfer - Bank Transfer
                        * other - Payment methods other than the named types above.
                      enum:
                      - cash
                      - check
                      - bank_transfer
                      - other
                      - custom
                      - tamara
                      - qpay
                      - blik
                      - fpx
                      - wero
                      - p24
                      example: null
                    reference_number:
                      type: string
                      deprecated: false
                      description: |
                        The reference number for this transaction. For example, check number when `payment_method` is `check`.
                      maxLength: 100
                      example: null
                    date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The date of occurrence of the transaction.
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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_items:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription_items
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The unique identifier of the [item price](/docs/api/item_prices) in Chargebee. At least one entry is required to import the subscription.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        The quantity of the item purchased
                      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 item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        The price or per-unit price of the item. When not provided, [the value set](/docs/api/item_prices/item-price-object) for the item price is used.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](https://www.chargebee.com/docs/2.0/price-override.html)
                        is enabled for the site, the price or per-unit price of the item can be set here. The [value set for the item price](/docs/api/item_prices/item_price-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/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        For the plan-item price:
                        the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then [the value set](/docs/api/item_prices/item-price-object)
                        for the plan-item price is used.

                        For addon-item prices:
                        If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)
                        are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then [the value set under attached addons](/docs/api/attached_items/attached-item-object)
                        is used. Further, if that value is not provided, then [the value set for the addon-item price](/docs/api/item_prices/item-price-object)
                        is used.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    trial_end:
                      type: array
                      description: |
                        The date/time when the trial period of the item ends. Applies to plan-items and--when [enabled](https://www.chargebee.com/docs/2.0/addons-trial.html)
                        --addon-items as well.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    service_period_days:
                      type: array
                      description: |
                        The service period of the item in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 730
                        minimum: 1
                        example: null
                      example: null
                    charge_on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          When `charge_on_option`
                          option is set to `on_event`
                          , this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.

                          * contract_termination -
                            when a contract term is [terminated](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option)
                            .
                          * subscription_trial_start - the time when the trial period of the subscription begins.
                          * plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                          * subscription_activation -
                            the moment a subscription enters an `active`
                            or `non-renewing`
                            state. Also includes reactivations of canceled subscriptions.
                          * subscription_creation - the time of creation of the subscription.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        Indicates if the charge-item is to be charged only once or each time the `charge_on_event`
                        occurs. This parameter only applies to charge-items.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    description:
                      type: array
                      description: "**Limited availability**\n\nSubscription-level\
                        \ item descriptions are available only on sites where this\
                        \ feature is enabled. Please reach out to the 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\nA description for this item that\
                        \ applies only to this subscription. When set, it is used\
                        \ on the customer-facing invoice instead of the description\
                        \ configured for the item price, and is returned as `entity_description`\
                        \ on the invoice [line item](/docs/api/invoices/invoice-object#invoice_line_items).\
                        \ When not set, the description configured for the item price\
                        \ is used.  \n**Constraints**\n\n* Maximum 500 characters.\n\
                        * Whether a description is shown on the invoice at all continues\
                        \ to be controlled by the item price's [show_description_in_invoices](/docs/api/item_prices#show_description_in_invoices)\
                        \ setting. This parameter determines which description is\
                        \ shown, not whether one is shown.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 500
                        example: null
                      example: null
                  required:
                  - item_price_id
                  example: null
                discounts:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for discounts
                  properties:
                    apply_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The amount on the invoice to which the discount is applied.

                          * invoice_amount -
                            The discount is applied to the invoice `sub_total`
                            .
                          * specific_item_price -
                            The discount is applied to the `invoice.line_item.amount`
                            that corresponds to the item price specified by `item_price_id`
                            .
                        enum:
                        - invoice_amount
                        - specific_item_price
                        example: null
                      example: null
                    duration_type:
                      type: array
                      items:
                        type: string
                        default: forever
                        deprecated: false
                        description: |
                          Specifies the time duration for which this discount is attached to the subscription.

                          * forever -
                            The discount is attached to the subscription and applied on the invoices till it is [explicitly removed](/docs/api/subscriptions/update-subscription-for-items#discounts_operation_type)
                            .
                          * 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 `period`
                            and `period_unit`
                            .
                          * one_time -
                            The discount stays attached to the subscription till it is applied on an invoice **once**.
                            It is removed after that from the subscription.
                        enum:
                        - one_time
                        - forever
                        - limited_period
                        example: null
                      example: null
                    percentage:
                      type: array
                      description: |
                        The percentage of the original amount that should be deducted from it.
                      items:
                        type: number
                        format: double
                        deprecated: false
                        maximum: 100
                        minimum: 0.01
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        The value of the discount. [The format of this value](/docs/api/currencies)
                        depends on the kind of currency.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    period:
                      type: array
                      description: |
                        The duration of time for which the discount is attached to the subscription, in `period_units`.
                        Applicable only when `duration_type`
                        is `limited_period`.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    period_unit:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The unit of time for `period`.
                          Applicable only when `duration_type`
                          is `limited_period`.

                          * day - A period of 24 hours.
                          * week - A period of 7 days.
                          * month - A period of 1 calendar month.
                          * year - A period of 1 calendar year.
                        enum:
                        - day
                        - week
                        - month
                        - year
                        example: null
                      example: null
                    included_in_mrr:
                      type: array
                      description: |
                        The discount is included in MRR calculations for your site. This attribute is only applicable when `duration_type`
                        is `one_time`
                        and when the [feature is enabled](https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation)
                        in Chargebee. Also, If the [site-level setting](https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation)
                        is to exclude one-time discounts from MRR calculations, this value is always returned `false`.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    item_price_id:
                      type: array
                      description: |
                        The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id) in the subscription to which the discount is to be applied.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Specifies the number of free units provided for the item, without affecting the total quantity sold
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                  required:
                  - duration_type
                  example: null
                charged_items:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for charged_items
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        Identifier of the [`charge` item price](/docs/api/item_prices) that was already charged for this subscription.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    last_charged_at:
                      type: array
                      description: |
                        Timestamp when this charge item price was last charged for this subscription in the source system.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
                item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_tiers
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The id of the item price for which the tier price is being overridden.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: |
                        The lowest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The highest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |
                        The overridden price of the tier. The value depends on the [type of currency](/docs/api/subscriptions)
                        .
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    pricing_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Pricing type for the tier.

                          * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                          * flat_fee -
                            Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                            pricing model, `pricing_type`
                            will be set to `flat_fee`
                            by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                          * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                        enum:
                        - per_unit
                        - flat_fee
                        - package
                        example: null
                      example: null
                    package_size:
                      type: array
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                  example: null
              required:
              - status
              example: null
            encoding:
              charged_items:
                style: deepObject
                explode: true
              contract_term:
                style: deepObject
                explode: true
              discounts:
                style: deepObject
                explode: true
              item_tiers:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              subscription_items:
                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: |
                      Resource object representing subscription
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: |
                      Resource object representing customer
                  card:
                    $ref: "#/components/schemas/Card"
                    description: |
                      Resource object representing card
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: |
                      Resource object representing invoice
                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:
      tags:
      - subscriptions
      summary: Retrieve advance invoice
      description: |
        **Caution**

        * This API will return an error when [multi-frequency billing](/docs/api/subscriptions#subscription-billing-frequencies) is enabled.

        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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
                  advance_invoice_schedules:
                    type: array
                    description: |
                      Resource object representing advance_invoice_schedule
                    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:
      tags:
      - subscriptions
      summary: Remove scheduled cancellation
      description: "Removes a scheduled cancellation from a subscription so that it\
        \ continues billing for the specified number of billing cycles.\nUse this\
        \ operation when a customer changes their mind about canceling their subscription.\
        \  \n\n### Prerequisites \\& Constraints\n\n* There must be a cancellation\
        \ scheduled for the subscription.\n* Do not invoke this API if the subscription\
        \ has a [`contract_term`](/docs/api/subscriptions#contract_term) associated\
        \ with it.\n* The subscription must not be a [gift subscription](/docs/api/gifts).\n\
        * The subscription `status` must be `in_trial`, `active` or `non_renewing`.\
        \  \n\n### Impacts\n\n**Subscription**  \n* The scheduled cancellation is\
        \ removed.\n* If the subscription `status` is `in_trial`, it does not change.\n\
        * If the subscription `status` is not `in_trial`, it becomes `active`.\n*\
        \ [`subscription.remaining_billing_cycles`](/docs/api/subscriptions#remaining_billing_cycles)\
        \ is set to the value of `billing_cycles`.\n* If `contract_term` is provided,\
        \ then a new `contract_term` is created on the subscription.  \n\n### Implementation\
        \ Notes\n\nBefore calling this API, perform the following checks:\n\n* Check\
        \ the `cancelled_at` attribute. It must be set to a future date-time, indicating\
        \ that a cancellation is scheduled.\n* Ensure that the `contract_term` attribute\
        \ is not present.\n* Confirm that the subscription `status` is `in_trial`,\
        \ `active` or `non_renewing`.  \n\n#### Related APIs\n\n[Cancel a subscription](/docs/api/subscriptions?prod_cat_ver=2#cancel_subscription_for_items)[Pause\
        \ a subscription](/docs/api/subscriptions?prod_cat_ver=2#pause_a_subscription)\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: "The number of billing cycles the subscription should\
                    \ remain active for after the current billing cycle. The [`remaining_billing_cycles`](/docs/api/subscriptions#remaining_billing_cycles)\
                    \ attribute of the subscription is updated to this value.  \n\
                    **Constraints**\n\n* The value must be greater than 0.  \n**Default\
                    \ Value**\n\n* If not specified, the value set for [`billing_cycles`](/docs/api/item_prices#billing_cycles)\
                    \ on the subscription's plan item price is used.\n"
                  minimum: 0
                  example: null
                contract_term_billing_cycle_on_renewal:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as `billing_cycles`
                    or a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)
                    .
                  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: |
                        Action to be taken when the contract term completes.

                        * cancel - Contract term completes and subscription is canceled.
                        * evergreen - Contract term completes and the subscription renews.
                        * renew -
                          * Contract term completes and a new contract term is started for the number of billing cycles specified in [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).
                          * The `action_at_term_end` for the new contract term is set to `renew`.
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      default: 0
                      deprecated: false
                      description: |
                        The number of days before [`contract_end`](/docs/api/contract_terms/contract_term-object#contract_end)
                        , 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.
                      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: |
                      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
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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:
      tags:
      - subscriptions
      summary: Retrieve a subscription with scheduled changes
      description: |
        **Note**
        If the [`ramp`](/docs/api/ramps)s feature is enabled and there is more than one ramp on a subscription, this API will return the subscription with the upcoming ramp applied.

        Retrieves a subscription with the scheduled changes applied.

        **Note:** Only the following attributes are changed

        * item_id
        * item_price_id
        * billing_period
        * billing_period_unit
        * remaining_billing_cycles
        * coupons Other attributes such as **status** ,**next_billing_at** are not changed and will reflect the current subscription values.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      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
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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:
      tags:
      - subscriptions
      summary: Reactivate a subscription
      description: "Reactivates a canceled subscription.\n\nUse this operation to\
        \ restore a canceled subscription to an active or in-trial state.\n\n####\
        \ Extend non-renewing subscriptions\n\nTo extend the billing cycles of a `non_renewing`\
        \ subscription, use the [Remove scheduled cancellation API](/docs/api/subscriptions/remove-scheduled-cancellation).\
        \  \n\n#### In-term reactivation\n\nThe subscription's current billing term\
        \ is demarcated by the [`current_term_start`](/docs/api/subscriptions/subscription-object#current_term_start)\
        \ and `current_term_end` attributes. These attributes are retained even if\
        \ the subscription is canceled. An \"in-term reactivation\" happens when the\
        \ subscription is reactivated on or before `current_term_end`.  \n\n### Prerequisites\
        \ \\& Constraints\n\n* The subscription `status` must be `cancelled`.  \n\n\
        ### Impacts\n\n**#### Subscription**  \n* For subscriptions canceled due to\
        \ payment failure, [in-term reactivation](#in-term) is governed by the Chargebee\
        \ Billing [configuration for reactivation](https://www.chargebee.com/docs/billing/2.0/subscriptions/reactivation#in-term-reactivation).\
        \  \n**#### Invoice**  \nIf an invoice gets generated during this operation,\
        \ customer [balances](/docs/api/customers#balances) such as promotional credits,\
        \ excess payments, and refundable credits are automatically applied subject\
        \ to [limits set at the site level](https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/credit-notes#credits-flexibility)\
        \ which can be overridden for subscriptions via [`subscription.billing_override`](/docs/api/subscriptions#billing_override).\
        \  \n\n### Use Cases\n\n#### Change the payment method during reactivation\n\
        \nUse the `payment_intent` parameter to create a payment source for the customer.\
        \ If reactivation generates an invoice and `auto_collection` is `on`, Chargebee\
        \ immediately attempts payment collection using the new payment source.  \n\
        **Note**\n\n* This works for both [Strong Customer Authentication](https://www.chargebee.com/docs/payments/2.0/others/psd2-sca)\
        \ (SCA) (i.e. 3D-Secure) and non-SCA flows.\n* The payment source replaces\
        \ the existing [primary payment source](/docs/api/customers#primary_payment_source_id)\
        \ for the customer.\n\n1. Create a `payment_intent` resource by calling the\
        \ [Create a payment intent API](/docs/api/payment_intents/create-a-payment-intent).\
        \ Set `amount` to the amount due for this reactivation.\n2. Pass the `payment_intent`\
        \ object to your frontend and use Chargebee.js to capture the payment source\
        \ details from the customer. You can use [Payment Components](https://www.chargebee.com/docs/payments/2.0/payment-components/overview)\
        \ to capture the payment source details.\n3. Listen to the [`payment_intent_updated`](/docs/api/events#payment_intent_updated)\
        \ event. Once the `payment_intent.status` is `authorized`, pass the `payment_intent.id`\
        \ using the `payment_intent[id]` parameter in this API call.  \n\n#### Related\
        \ APIs\n\n[Remove scheduled cancellation](/docs/api/subscriptions?prod_cat_ver=2#remove_scheduled_cancellation)\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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: "Providing this parameter indicates that the subscription\
                    \ reactivates with an `in_trial` status and the trial period ends\
                    \ at the date provided.  \n**Constraints**\n\n* Must not be earlier\
                    \ than `reactivate_from` if `reactivate_from` is provided.\n*\
                    \ When `trial_end` is backdated, the subscription immediately\
                    \ goes into `active` or `non_renewing` status.\n"
                  example: null
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: "The number of billing cycles (including the current\
                    \ cycle) this subscription should remain active for. After the\
                    \ billing cycles are exhausted, the subscription is canceled automatically.\
                    \  \n**Default value**\n\n* If not specified, the billing cycles\
                    \ [configured for the plan](/docs/api/item_prices#billing_cycles)\
                    \ are used.  \n**Impact**\n\n* The [`remaining_billing_cycles`](/docs/api/subscriptions#remaining_billing_cycles)\
                    \ attribute of the subscription is updated to one less than the\
                    \ value of this parameter.\n"
                  minimum: 0
                  example: null
                reactivate_from:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: "The date-time at which the subscription was reactivated.\
                    \ When not provided, the subscription is reactivated immediately\
                    \ on calling this API.  \n**Prerequisites**\n\n* The [backdating\
                    \ feature](https://www.chargebee.com/docs/billing/2.0/subscriptions/backdating#configuring-backdated-subscription-actions-and-invoicing)\
                    \ has been enabled for subscription reactivation operations.\n\
                    * 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.\n\n**Constraints**\n\n* Must be in the past.\n\
                    * Must not be more than the billing period of the plan into the\
                    \ past. For example, if the period of the plan in the subscription\
                    \ is 2 months and today is 14th April, `reactivate_from` cannot\
                    \ be earlier than 14th February.\n* Must not be after `trial_end`\
                    \ if `trial_end` is provided.\n"
                  example: null
                invoice_immediately:
                  type: boolean
                  deprecated: false
                  description: "If there are charges raised immediately for the subscription,\
                    \ this parameter specifies whether those charges are to be invoiced\
                    \ immediately or added to [unbilled charges](https://www.chargebee.com/docs/unbilled-charges.html).\n\
                    The default value is as per the [site settings](https://www.chargebee.com/docs/unbilled-charges.html#configuration)\n\
                    .  \n**Note:**\n`invoice_immediately`\nonly 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.\n\n.\n"
                  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: |
                    The number of subscription billing cycles to [invoice in advance](https://www.chargebee.com/docs/advance-invoices.html).
                    If a new term is started for the subscription due to this API call, then `terms_to_charge`
                    is inclusive of this new term. See description for the `force_term_reset`
                    parameter to learn more about when a subscription term is reset.
                  minimum: 1
                  example: null
                invoice_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: "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. Moreover,\
                    \ if `create_pending_invoices` is `true`, 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. `taxes`\
                    \ and `line_item_taxes` are computed based on the tax configuration\
                    \ as of `invoice_date`.  \n**Default value**\n\n* Current date.\
                    \  \n**Constraints**\n\n* Must be in the past.\n* Must 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.\n* Must not be earlier than `reactivate_from`\
                    \ or `trial_end`.\n* `invoice_immediately` must be `true`.\n"
                  example: null
                contract_term_billing_cycle_on_renewal:
                  type: integer
                  format: int32
                  deprecated: false
                  description: "The number of billing cycles the new contract term\
                    \ should run for, on contract renewal. This value is used when\
                    \ `action_at_term_end` is `renew`.  \n**Constraints**\n\n* Should\
                    \ not be sent when `contract_term.action_at_term_end` is `cancel`\
                    \ or `evergreen`.  \n**Default value**\n\n* Defaults to the value\
                    \ of `billing_cycle` or a custom value depending on the [site\
                    \ configuration](https://www.chargebee.com/docs/billing/2.0/subscriptions/contract-terms#configuring-contract-terms).\n"
                  maximum: 100
                  minimum: 1
                  example: null
                payment_initiator:
                  type: string
                  deprecated: false
                  description: |
                    The initiator of this payment request. Sending this information can improve the success rate of the payment at the gateway.

                    * customer - The payment was initiated by your customer.
                    * merchant - The payment was initiated by you (the merchant).
                  enum:
                  - customer
                  - merchant
                  example: null
                contract_term:
                  type: object
                  deprecated: false
                  description: "Parameters for creating a contract term for the subscription.\
                    \  \n**Prerequisites**\n\n* [Contract Terms](https://www.chargebee.com/docs/contract-terms.html)\
                    \ feature must be enabled for the site.\n"
                  properties:
                    action_at_term_end:
                      type: string
                      deprecated: false
                      description: "Action to be taken when the contract term completes.\
                        \  \n**Constraints**\n\n* `billing_cycles` must be provided\
                        \ when this parameter is sent.\n\n* evergreen - The contract\
                        \ term completes and the subscription continues to renew without\
                        \ a new contract term.\n* renew - The contract term completes\
                        \ and a new contract term is started for the number of billing\
                        \ cycles specified in `contract_term_billing_cycle_on_renewal`.\
                        \ The `action_at_term_end` for the new contract term is set\
                        \ to `renew`.\n* cancel - Contract term completes and subscription\
                        \ is canceled.\n"
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      default: 0
                      deprecated: false
                      description: "The number of days before `contract_end` during\
                        \ which the customer is barred from canceling the contract\
                        \ term. The customer can cancel the contract term via the\
                        \ [Self-Serve Portal](https://www.chargebee.com/docs/self-serve-portal.html)\
                        \ only before this period. This allows you to have sufficient\
                        \ time for processing the contract term closure.  \n**Required\
                        \ if**\n\n* The `action_at_term_end` is `renew`.  \n**Constraints**\n\
                        \n* Must be less than the duration of the contract term (in\
                        \ days).\n* Should not be sent when `action_at_term_end` is\
                        \ `cancel` or `evergreen`.\n"
                      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/2.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 the [`payment_intent`](payment_intents)\
                        \ resource. If you provide this parameter, you do not need\
                        \ to pass other `payment_intent` parameters.  \n**Prerequisites**\n\
                        \n* The value of [`payment_intent.status`](payment_intents#payment_intent_status)\
                        \ must be `authorized`.\n"
                      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 payment method type.  \n**Default value**\n\
                        \n* `card`\n\n* alipay_hk - Payments made via Alipay HK.\n\
                        * card - card\n* twint - Payments made via Twint\n* swish\
                        \ - Payments made via Swish\n* after_pay - Payments made via\
                        \ Afterpay\n* netbanking_emandates - netbanking_emandates\n\
                        * nequi - Payments made via Nequi.\n* grab_pay - Payments\
                        \ made via GrabPay\n* paypay - PayPay\n* payconiq_by_bancontact\
                        \ - Payments made via Payconiq by Bancontact.\n* dotpay -\
                        \ dotpay\n* mercado_pago - Payments made via Mercado Pago.\n\
                        * faster_payments - Faster Payments\n* p24 - Payments made\
                        \ via Przelewy24 (P24).\n* upi - upi\n* kbc_payment_button\
                        \ - KBC Payment Button\n* electronic_payment_standard - Electronic\
                        \ Payment Standard\n* klarna - Payments made via Klarna.\n\
                        * payme - Payments made via PayMe\n* direct_debit - direct_debit\n\
                        * sepa_instant_transfer - Sepa Instant Transfer\n* bancontact\
                        \ - bancontact\n* thai_qr - Payments made via Thai QR.\n*\
                        \ go_pay - Payments made via GoPay\n* wero - Payments made\
                        \ via Wero.\n* pay_by_bank - Pay By Bank\n* touch_n_go - Payments\
                        \ made via Touch 'n Go.\n* google_pay - google_pay\n* apple_pay\
                        \ - apple_pay\n* qpay - Payments made via Qpay.\n* online_banking_poland\
                        \ - Online Banking Poland\n* trustly - Trustly\n* gcash -\
                        \ Payments made via GCash.\n* naver_pay - Payments made via\
                        \ Naver Pay.\n* nupay - Payments made via NuPay.\n* stablecoin\
                        \ - Payments made via Stablecoin.\n* giropay - giropay\n*\
                        \ paypal_express_checkout - paypal_express_checkout\n* pix\
                        \ - Pix\n* venmo - Venmo\n* klarna_pay_now - Klarna Pay Now\n\
                        * momo - Payments made via MoMo.\n* alipay - Payments made\
                        \ via Alipay.\n* sofort - sofort\n* amazon_payments - Amazon\
                        \ Payments\n* affirm_pay - Payments made via Affirm Pay.\n\
                        * tamara - Payments made via Tamara.\n* ideal - ideal\n* kakao_pay\
                        \ - Payments made via Kakao Pay.\n* picpay - Payments made\
                        \ via PicPay.\n* fpx - Payments made via FPX.\n* blik - Payments\
                        \ made via BLIK.\n* pay_to - PayTo\n* ovo - Payments made\
                        \ via OVO.\n* dana - Payments made via Dana.\n* south_korean_cards\
                        \ - Payments made via South Korean Cards\n* boleto - boleto\n\
                        * pay_co - Payments made via PayCo\n* revolut_pay - Payments\
                        \ made via Revolut Pay.\n* wechat_pay - Payments made via\
                        \ WeChat Pay.\n* cash_app_pay - Payments made via Cash App\
                        \ Pay.\n* rakuten_pay - Payments made via Rakuten Pay.\n"
                      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
                      - alipay_hk
                      - paypay
                      - gcash
                      - south_korean_cards
                      - paynow
                      - bizum
                      - promptpay
                      - dana
                      - touch_n_go
                      - tamara
                      - qpay
                      - ovo
                      - momo
                      - mercado_pago
                      - nequi
                      - nupay
                      - picpay
                      - thai_qr
                      - blik
                      - fpx
                      - wero
                      - p24
                      - affirm_pay
                      - rakuten_pay
                      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: |
                        * `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal).

                          * `payer`: User related information.
                            * `country_of_residence`: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a [two-character ISO code](https://docs.checkout.com/resources/codes/country-codes).
                            * `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
                        * `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
                        * `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user's `device_session_id` can be added to perform [additional validation](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                            * `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
                        * `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
                        * `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                        * `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.

                          * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
                        * `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.

                          * `payer`: User related information.
                            * `document`: Document is the user's identification number based on their country.
                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device
                      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: |
                      Resource object representing subscription
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: |
                      Resource object representing customer
                  card:
                    $ref: "#/components/schemas/Card"
                    description: |
                      Resource object representing card
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: |
                      Resource object representing invoice
                  unbilled_charges:
                    type: array
                    description: |
                      Resource object representing unbilled_charge
                    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:
      tags:
      - subscriptions
      summary: Charge future renewals
      description: "Creates a single [advance invoice](/docs/api/invoices/invoice-object#invoice_has_advance_charges)\
        \ or an [advance invoicing schedule](/docs/api/advance_invoice_schedules#advance_invoice_schedule)\
        \ for a [subscription](/docs/api/subscriptions).\n\nUse this operation to\
        \ bill future renewals in advance, enabling customers to prepay for upcoming\
        \ billing cycles.  \n\n### Prerequisites \\& Constraints\n\n* The [Advance\
        \ Invoicing](https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/advance-invoices)\
        \ feature must be enabled on the site.\n* The subscription [`status`](/docs/api/subscriptions/subscription-object#subscription_status)\
        \ must be `active`.\n* The subscription must not be scheduled for [cancellation](/docs/api/subscriptions/cancel-subscription-for-items)\
        \ or [pause](/docs/api/subscriptions/pause-a-subscription) within the terms\
        \ being invoiced.\n* The subscription must have at least one item price belonging\
        \ to a [non-`metered` item](/docs/api/items/item-object#item_metered).\n*\
        \ The [Multi-Frequency Billing](https://apidocs.chargebee.com/docs/api/subscriptions?lang=curl#subscription-billing-frequencies)\
        \ feature must be disabled for the site.\n* The subscription must not be a\
        \ [gift](/docs/api/gifts) subscription. You can check this by [listing all\
        \ gifts](/docs/api/gifts/list-gifts) setting the filter parameter `gift_receiver[customer_id][is]`\
        \ to the `customer_id` of the subscription and checking if one of the returned\
        \ objects has [`gift_receiver.subscription_id`](/docs/api/gifts/gift-object#gift_gift_receiver)\
        \ matching the `id` of the subscription.\n* For subscriptions with [ramps](/docs/api/ramps),\
        \ the following constraints apply:\n  * The subscription must not have more\
        \ than 12 scheduled ramps in the invoicing period specified by this API.\n\
        \  * For the invoicing period specified by this API, the subscription must\
        \ not have any ramps scheduled for the middle of the subscription term.\n\
        * The subscription must not be in its final contract term. i.e. the subscription\
        \ must not have [`contract_term.action_at_term_end`](/docs/api/subscriptions/subscription-object#contract_term)\
        \ set to `cancel`.\n* The subscription must not have [addons in trial](https://www.chargebee.com/docs/billing/2.0/subscriptions/addons-trial).\
        \  \n\n### Impacts\n\n**Subscription**  \n* The subscription [`next_billing_at`](/docs/api/subscriptions/subscription-object#subscription_next_billing_at)\
        \ is updated to reflect the end of the last term being invoiced. If all remaining\
        \ billing cycles are invoiced, `next_billing_at` is set to `null`.\n* The\
        \ subscription's [`remaining_billing_cycles`](/docs/api/subscriptions/subscription-object#subscription_remaining_billing_cycles)\
        \ is reduced by the number of terms charged.  \n**Invoice**  \n* When `schedule_type`\
        \ is `immediate` and `invoice_immediately = true`:\n  * a single [advance\
        \ invoice](/docs/api/invoices/invoice-object#invoice_has_advance_charges)\
        \ is created covering the specified number of future billing cycles.\n  *\
        \ the invoice includes line items for all non-metered items, applicable coupons,\
        \ taxes, and credits.\n  * any changes scheduled in the current term or at\
        \ the end of the current term for the subscription are automatically taken\
        \ into account while generating the advance invoice.\n* if `auto_collection`\
        \ is `on` for the subscription, the payment for the invoice is collected immediately\
        \ using the [payment source](/docs/api/subscriptions/subscription-object#subscription_payment_source_id)\
        \ associated with the subscription.  \n**Unbilled Charges**  \n* When `schedule_type`\
        \ is `immediate` and `invoice_immediately` is `false`: The charges are added\
        \ to [`unbilled_charges`](/docs/api/unbilled_charges) for the subscription\
        \ and invoiced on the next renewal.  \n**Advance Invoice Schedule**  \n* When\
        \ `schedule_type` is `specific_dates` or `fixed_intervals`:\n  * an [advance\
        \ invoice schedule](/docs/api/advance_invoice_schedules) is created. The schedule\
        \ defines when advance invoices will be generated in the future.\n  * any\
        \ changes scheduled for the subscription are automatically taken into account\
        \ while generating the advance invoice.\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: "The number of billing cycles to charge, depending\
                    \ on the `schedule_type`:\n\n* For `schedule_type = immediate`:\
                    \ The number of future billing cycles to be invoiced in advance.\
                    \ The invoicing is done for the [`remaining_billing_cycles`](/docs/api/subscriptions/subscription-object#subscription_remaining_billing_cycles)\
                    \ of the subscription if that is less than `terms_to_charge`.\n\
                    * For `schedule_type = fixed_intervals`: The number of future\
                    \ billing cycles in one interval. The schedule is created such\
                    \ that the total number of billing cycles in the schedule does\
                    \ not exceed the `remaining_billing_cycles` of the subscription.\n\
                    \n**Constraints**\n\n* Must be greater than 0.\n* Must not exceed\
                    \ the maximum terms allowed for advance invoicing (configured\
                    \ in [site settings](https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/advance-invoices)).\n\
                    * The value must not exceed the `remaining_billing_cycles` of\
                    \ the subscription.  \n**Default value**\n\n* `1`\n"
                  minimum: 1
                  example: null
                invoice_immediately:
                  type: boolean
                  deprecated: false
                  description: "Whether the charge should be invoiced immediately\
                    \ or added to [`unbilled_charges`](/docs/api/unbilled_charges).\
                    \  \n**Prerequisite**\n\n* If `invoice_immediately` is `true`\
                    \ and `auto_collection` is `on` for the subscription, there must\
                    \ be a valid and active online [`payment_source`](/docs/api/payment_sources)\
                    \ associated with the [subscription](/docs/api/subscriptions/subscription-object#subscription_payment_source_id)\
                    \ or the customer.  \n**Constraints**\n\n* The `schedule_type`\
                    \ must be `immediate`.  \n**Default value**\n\n* `true`\n"
                  example: null
                schedule_type:
                  type: string
                  deprecated: false
                  description: "The type of advance invoice or advance invoicing schedule.\
                    \  \n**Default value**\n\n* `immediate`\n\n* immediate -\n  Bill\
                    \ immediately for the number of billing cycles specified by `terms_to_charge`.\
                    \  \n  **Prerequisite**\n\n  * There must not be an existing advance\
                    \ invoice or an advance invoice schedule for the subscription.\n\
                    * specific_dates -\n  Invoice on specific dates.  \n  **Prerequisite**\n\
                    \n  * There should not be an existing advance invoice schedule\
                    \ of `schedule_type` = `fixed_intervals` for the subscription.\n\
                    \  * The total number of advance invoice schedules (existing and\
                    \ new ones scheduled through this API) of `schedule_type` = `specific_dates`\
                    \ must not exceed 5.  \n  **Constraints**\n\n  * When this option\
                    \ is selected, you must provide `specific_dates_schedule[date]`.\n\
                    * fixed_intervals -\n  Invoice at fixed intervals of time.  \n\
                    \  **Prerequisite**\n\n  * There should not be any existing advance\
                    \ invoice schedule for the subscription.  \n  **Constraints**\n\
                    \n  * When this option is selected, you must provide the following\
                    \ parameters:\n    * `terms_to_charge`\n    * `fixed_interval_schedule[days_before_renewal]`\n\
                    \    * `fixed_interval_schedule[end_schedule_on]`\n"
                  enum:
                  - immediate
                  - specific_dates
                  - fixed_intervals
                  example: null
                fixed_interval_schedule:
                  type: object
                  deprecated: false
                  description: "Parameters for fixed_interval_schedule.  \n**Required\
                    \ if**\n\n* `schedule_type` is `fixed_intervals`.  \n**Constraint**\n\
                    \n* There must be exactly one element in the `fixed_interval_schedule`\
                    \ array.\n"
                  properties:
                    number_of_occurrences:
                      type: integer
                      format: int32
                      deprecated: false
                      description: "The number of advance invoices to generate.  \n\
                        **Required if**\n\n* `fixed_interval_schedule[end_schedule_on]`\
                        \ is set to `after_number_of_intervals`.  \n**Impact**\n\n\
                        * The schedule is created such that the total number of billing\
                        \ cycles in the schedule does not exceed the [`remaining_billing_cycles`](/docs/api/subscriptions/subscription-object#subscription_remaining_billing_cycles)\
                        \ of the subscription.\n"
                      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.  \n**Constraints**\n\n* For weekly\
                        \ billing periods: Must be less than or equal to `5` days.\n\
                        * For monthly billing periods: Must be less than or equal\
                        \ to `25` days for 1-month periods.\n* For yearly billing\
                        \ periods: Must be less than or equal to `363` days.\n* For\
                        \ daily billing periods: `days_before_renewal` should not\
                        \ be provided.\n"
                      minimum: 1
                      example: null
                    end_schedule_on:
                      type: string
                      deprecated: false
                      description: "Specifies when the advance invoicing schedule\
                        \ ends.\n\n* after_number_of_intervals -\n  Advance invoices\
                        \ are generated a specified number of times.  \n  **Constraint**\n\
                        \n  * You must provide `fixed_interval_schedule[number_of_occurrences]`.\n\
                        * subscription_end - Advance invoices are generated for as\
                        \ long as the subscription is active.\n* specific_date -\n\
                        \  The advance invoicing schedule ends on a specific date.\
                        \  \n  **Constraint**\n\n  * You must provide `fixed_interval_schedule[end_date]`.\n"
                      enum:
                      - after_number_of_intervals
                      - specific_date
                      - subscription_end
                      example: null
                    end_date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: "The date when the advance invoicing schedule ends.\
                        \ Advance invoices are not generated beyond this date.  \n\
                        **Constraints**\n\n* `fixed_interval_schedule[end_schedule_on]`\
                        \ must be set to `specific_date`.\n* Must be a future date.\n\
                        * Must be at least 1 day before the start of the last billing\
                        \ cycle of the subscription.\n* Must be within 5 years from\
                        \ the current date.\n"
                      example: null
                  example: null
                specific_dates_schedule:
                  type: object
                  deprecated: false
                  description: "Parameters for specific_dates_schedule.  \n**Required\
                    \ if**\n\n* `schedule_type` is `specific_dates`.  \n**Constraints**\n\
                    \n* The total number of schedules on the subscription (existing\
                    \ and new ones scheduled through this API) must not exceed 5.\n"
                  properties:
                    terms_to_charge:
                      type: array
                      description: "The number of billing cycles to charge for on\
                        \ the specified date.  \n**Constraints**\n\n* The `schedule_type`\
                        \ must be `specific_dates`.\n* Must be greater than 0.\n*\
                        \ Must not exceed the maximum terms allowed for advance invoicing\
                        \ (configured in [site settings](https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/advance-invoices)).\n\
                        * The total number of billing cycles across all schedules\
                        \ must not exceed the [`remaining_billing_cycles`](/docs/api/subscriptions/subscription-object#subscription_remaining_billing_cycles)\
                        \ of the subscription.  \n**Default value**\n\n* `1`\n"
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    date:
                      type: array
                      description: "The date on which the advance invoice should be\
                        \ generated. This is the scheduled date for generating the\
                        \ invoice for the specified number of billing cycles.  \n\
                        **Constraints**\n\n* The `schedule_type` must be `specific_dates`.\n\
                        * Must be before the start of the billing period(s) that will\
                        \ be invoiced.\n* Must be a future date within 5 years from\
                        \ the current date.\n"
                      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: |
                      Resource object representing subscription
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: |
                      Resource object representing customer
                  card:
                    $ref: "#/components/schemas/Card"
                    description: |
                      Resource object representing card
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: |
                      Resource object representing invoice
                  advance_invoice_schedules:
                    type: array
                    description: |
                      Resource object representing advance_invoice_schedule
                    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:
      tags:
      - subscriptions
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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/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: |
                      Resource object representing estimate
                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:
      tags:
      - subscriptions
      summary: Remove scheduled changes from a subscription
      description: "Removes a scheduled change from a subscription.  \n\n##### Review\
        \ the changes before removing them\n\nTo review the scheduled subscription\
        \ change before removing it, call [Retrieve with scheduled changes](/docs/api/subscriptions/retrieve-with-scheduled-changes)\
        \ **before** calling this API to retrieve the subscription resource with the\
        \ scheduled change applied.  \n\n### Prerequisites \\& Constraints\n\n* The\
        \ subscription's [`has_scheduled_changes`](/docs/api/subscriptions/subscription-object#has_scheduled_changes)\
        \ attribute is `true`.\n* The subscription has exactly **one** scheduled change.\
        \ If multiple [ramps](/docs/api/ramps) exist, the API returns an error.  \n\
        \n### Impacts\n\n**Subscription**  \n* Removes the scheduled change.\n* Clears\
        \ [`changes_scheduled_at`](/docs/api/subscriptions/subscription-object#changes_scheduled_at),\
        \ if set.\n* Sets `has_scheduled_changes` to `false`.  \n**Invoices**  \n\
        * If any [advance invoices](/docs/api/invoices/invoice-object#has_advance_charges)\
        \ account for the scheduled change, Chargebee creates [credit notes](/docs/api/credit_notes)\
        \ against those invoices.  \n**Credit Notes**  \n* Creates the following credit\
        \ notes against any advance invoices that account for the scheduled change:\n\
        \  * `adjustment`: for `amount_to_collect` on the advance invoice.\n* `refundable`:\
        \ for the refundable amount on the advance invoice.  \n\n### Implementation\
        \ Notes\n\nBefore you call this API, confirm the following:\n\n* The subscription's\
        \ `has_scheduled_changes` attribute is `true`.\n* Exactly one scheduled change\
        \ exists. To verify, call [List ramps](/docs/api/ramps/list-ramps) and filter\
        \ by `subscription_id`. The response must include exactly one `ramp` object.\
        \  \n\n#### Related APIs\n\n[Retrieve with scheduled changes](/docs/api/subscriptions?prod_cat_ver=2#retrieve_with_scheduled_changes)[List\
        \ ramps](/docs/api/ramps?prod_cat_ver=2#list_ramps)\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing subscription
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: |
                      Resource object representing customer
                  card:
                    $ref: "#/components/schemas/Card"
                    description: |
                      Resource object representing card
                  credit_notes:
                    type: array
                    description: |
                      Resource object representing credit_note
                    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:
      tags:
      - subscriptions
      summary: Change term end
      description: "Use this endpoint to adjust when a subscription's current term\
        \ or trial ends without altering the plan or billing frequency. It is helpful\
        \ when you need to align renewals to a specific calendar date or extend a\
        \ trial. Future renewals will follow the new date, keeping the subscription\
        \ cadence intact.  \n\n### Prerequisites \\& Constraints\n\nSubscriptions\
        \ must be in one of the following [`status`](/docs/api/subscriptions/subscription-object#status)\
        \ values: `in_trial`, `active`, `non_renewing`.  \n\n### Impacts\n\n**Subscription**\
        \  \nBased on the subscription's `status`, the following updates are made:\n\
        \n* If the status is `in_trial`, the `trial_end` is set to the new date.\n\
        * If the status is `active`, the `current_term_end` is set to the new date.\n\
        * If the status is `non_renewing`, the upcoming cancellation date is set to\
        \ the new date.  \n**Invoices and Credit Notes**  \nThe API can generate unbilled\
        \ charges, invoice, or credit notes. You can control the behaviour using `prorate`\
        \ and `invoice_immediately` parameters.\nTo preview invoices, credits, and\
        \ dates, use the [Change term end estimate](/docs/api/estimates/subscription-change-term-end-estimate)\
        \ endpoint.  \n**Advance Charges**  \nIf there are advance charges, then credit\
        \ notes are issued for the unused portion of the service period.  \n**Scheduled\
        \ Pause**  \nIf the subscription is **scheduled** to **pause** at the end\
        \ of the current term, the pause date is updated to match the new term end\
        \ date.  \n**Ramps**  \nIf [subscription ramps](/docs/api/ramps) are present,\
        \ this operation moves them to the `draft` state. Update and reschedule the\
        \ ramps as needed to keep them in sync.  \n\n### Implementation Notes\n\n\
        The request fails with `invalid_state` if the subscription is **not** in one\
        \ of the `trial`, `active`, or `non_renewing` states. Validate the status\
        \ before invoking this API.\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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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. The value must be a date in the future, i.e. later than current time. The value must not be the same as [next_billing_at](/docs/api/subscriptions/subscription-object#next_billing_at)
                    .
                  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: "If there are charges raised immediately for the subscription,\
                    \ this parameter specifies whether those charges are to be invoiced\
                    \ immediately or added to [unbilled charges](https://www.chargebee.com/docs/unbilled-charges.html).\n\
                    The default value is as per the [site settings](https://www.chargebee.com/docs/unbilled-charges.html#configuration)\n\
                    .  \n**Note:**\n`invoice_immediately`\nonly 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.\n\n.\n"
                  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: |
                      Resource object representing subscription
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: |
                      Resource object representing customer
                  card:
                    $ref: "#/components/schemas/Card"
                    description: |
                      Resource object representing card
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: |
                      Resource object representing invoice
                  unbilled_charges:
                    type: array
                    description: |
                      Resource object representing unbilled_charge
                    items:
                      $ref: "#/components/schemas/UnbilledCharge"
                      description: Resource object representing unbilled_charge
                    example: null
                  credit_notes:
                    type: array
                    description: |
                      Resource object representing credit_note
                    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:
      tags:
      - subscriptions
      summary: Delete a subscription
      description: "Deletes a specified subscription.\n\nThis operation schedules\
        \ the subscription resource for deletion, and it is **permanently** deleted\
        \ after a few minutes.\nIf you wish to retain the subscription data but stop\
        \ further renewals, consider [canceling](/docs/api/subscriptions/cancel-subscription-for-items)\
        \ or [pausing](/docs/api/subscriptions/pause-a-subscription) the subscription\
        \ instead.  \n\n### Prerequisites \\& Constraints\n\n* There must not be any\
        \ [invoices](/docs/api/invoices) belonging to this subscription that have\
        \ allocations from [credit notes](/docs/api/credit_notes) **not** belonging\
        \ to this subscription.\n* There must not be any credit notes belonging to\
        \ this subscription that have been allocated to invoices **not** belonging\
        \ to this subscription.\n* There should not be any consolidated invoices for\
        \ the [customer](/docs/api/customers) with lines belonging to this subscription.\
        \  \n\n### Impacts\n\n**Invoices**  \n* All the invoices belonging to the\
        \ subscription are deleted.\n* See [Delete an invoice API](/docs/api/invoices/delete-an-invoice)\
        \ for more details on the impacts of deleting an invoice.  \n**Credit notes**\
        \  \nAll the credit notes belonging to this subscription are deleted.  \n\
        **Transactions**  \nAll the [transactions](/docs/api/transactions) belonging\
        \ to this subscription are deleted.  \n**Usages**  \nAll [usages](/docs/api/usages)\
        \ belonging to this subscription are deleted.  \n**Usage events**  \nDeleting\
        \ a subscription does **not** delete the associated [usage events](/docs/api/usage_events).\
        \  \n**Reporting**  \nThe numbers in the following [reports](https://www.chargebee.com/docs/billing/2.0/reports-and-analytics/metric_description)\
        \ are modified when a subscription is deleted: Payments, New Revenue, Signups,\
        \ Activations, Cancellations, and Refunds.  \n**Integrations**  \nDeleting\
        \ a subscription may affect any [third-party integrations](https://www.chargebee.com/docs/billing/2.0/integrations/sales-integration-index)\
        \ you may have with Chargebee Billing. Review all integrations to assess the\
        \ impact before proceeding.  \n\n### Implementation Notes\n\nBefore deleting\
        \ a subscription, ensure the following:\n\n* Retrieve all the invoices for\
        \ this subscription using the [List invoices API](/docs/api/invoices/list-invoices).\
        \ For each invoice, look up all the applied credit notes (`credit_note.applied_credits.cn_id`).\
        \ For all such credit notes, check if the associated subscription (`credit_note.subscription_id`)\
        \ is this subscription. If not, use the [Remove credit note from an invoice\
        \ API](/docs/api/invoices/remove-credit-note-from-an-invoice) to remove the\
        \ credit note allocation.\n* Retrieve all the credit notes for this subscription\
        \ using the [List credit notes API](/docs/api/credit_notes/list-credit-notes).\
        \ For each credit note, look up all the invoice allocations (`credit_note.allocations.invoice_id`).\
        \ For all such invoices, check if the associated subscription (`invoice.subscription_id`)\
        \ is this subscription. If not, use the [Remove credit note from an invoice\
        \ API](/docs/api/invoices/remove-credit-note-from-an-invoice) to remove the\
        \ allocation.\n* [Delete](/docs/api/invoices/delete-an-invoice) any consolidated\
        \ invoices containing lines belonging to this subscription.  \n\n#### Related\
        \ APIs\n\n[Pause a subscription](/docs/api/subscriptions?prod_cat_ver=2#pause_a_subscription)[Cancel\
        \ a subscription](/docs/api/subscriptions?prod_cat_ver=2#cancel_subscription_for_items)\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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      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
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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}/subscription_for_items:
    post:
      tags:
      - customers
      summary: Create a subscription
      description: |
        **Note:**
        This endpoint optionally supports 3DS. To use it [create](/docs/api/payment_intents/create-a-payment-intent)
        a `payment_intent`
        and provide it via this endpoint.

        Creates a new subscription for an existing customer in Chargebee. Any available [credits and excess payments](/docs/api/customers/customer-object#balances) for the customer are automatically applied on the invoice.
      operationId: create_subscription_for_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
                business_entity_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [business entity](/docs/api/advanced-features)\
                    \ this subscription should be [linked](/docs/api/advanced-features)\
                    \ to. Applicable only when multiple business entities have been\
                    \ created for the site. This must be the same as the business\
                    \ entity of the `{customer_id}` for the operation to be successful.\
                    \  \n**Note**\n\nAn alternative way of passing this parameter\
                    \ is by means of a [custom HTTP header](/docs/api/advanced-features).\n"
                  maxLength: 50
                  example: null
                brand_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [brand](/docs/api/brands) this\
                    \ subscription should be linked to. Applicable only when multiple\
                    \ brands have been created for the site. Unlike `business_entity_id`,\
                    \ this need not match the brand of the `{customer_id}`; when the\
                    \ two differ, the value provided here is used for the subscription.\
                    \ An alternative way of passing this parameter is by means of\
                    \ the `chargebee-brand-id` custom HTTP header; when both are provided,\
                    \ they must specify the same brand.  \n**Default behavior**\n\n\
                    * When not provided, the subscription is linked to the brand of\
                    \ the customer it is created for.\n"
                  maxLength: 50
                  example: null
                trial_end:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    End of the trial period for the subscription. This overrides the trial period set for the plan-item. The value must be later than `start_date`.
                    Set it to `0`
                    to have no trial period.
                  example: null
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    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 [contract term](/docs/api/contract_terms) or not.

                    * When the subscription is not on a contract term: if `billing_cycles` is not provided, then the billing cycles [set for the plan-item price](/docs/api/item_prices/item_price-object#billing_cycles) is used. Moreover, once the `billing_cycles` have completed, the subscription cancels.
                    * When the subscription is on a contract term: Providing `billing_cycles` is mandatory. Moreover, once the `billing_cycles` have completed, the behavior of the subscription is determined by the `contract_term[action_at_term_end]` parameter.
                  minimum: 0
                  example: null
                mandatory_items_to_remove:
                  type: array
                  deprecated: false
                  description: |
                    Item ids of [mandatorily attached addons](/docs/api/attached_items)
                    that are to be removed from the subscription.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                net_term_days:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Defines [Net D](https://www.chargebee.com/docs/net_d.html)
                    for the subscription. Net D is the number of days from [`invoice.date`](/docs/api/invoices/invoice-object#date) until payment for the invoice is due.

                    * If a value is provided: Net D is set explicitly for the subscription to the value provided. The value must be one among those defined in the [site configuration](https://www.chargebee.com/docs/net_d.html#enable-net-d-for-chargebee-invoices).
                    * If not provided: The attribute is not set and therefore not returned by the API. In this case, when an invoice is raised - whether now or later - the `net_term_days` defined at the [customer level](/docs/api/customers/customer-object#net_term_days) is considered. .
                  example: null
                start_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    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:

                    * Backdating is enabled for subscription creation operations.
                    * 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.
                    * 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, `start_date` cannot be earlier than 14th February. .
                  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
                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: |
                    If `true`
                    , ignores the [hierarchy relationship](/docs/api/customers/customer-object#relationship)
                    and uses customer as payment and invoice owner.
                  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: |
                    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 `create_pending_invoices`
                    is set to `true`
                    , 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. `taxes`
                    and `line_item_taxes`
                    are computed based on the tax configuration as of `invoice_date`.
                    When passing this parameter, the following prerequisites must be met:

                    * `invoice_date` must be in the past.
                    * It is not earlier than `start_date`.
                    * 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.
                    * `invoice_immediately` is true. .
                  example: null
                meta_data:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: "A collection of key-value pairs that provides extra\
                    \ information about the subscription.  \n**Note:**\nThere's a\
                    \ character limit of 65,535.\n\n[Learn more](/docs/api/advanced-features)\n\
                    .\n"
                  example: null
                invoice_immediately:
                  type: boolean
                  deprecated: false
                  description: "If there are charges raised immediately for the subscription,\
                    \ this parameter specifies whether those charges are to be invoiced\
                    \ immediately or added to [unbilled charges](https://www.chargebee.com/docs/unbilled-charges.html).\n\
                    The default value is as per the [site settings](https://www.chargebee.com/docs/unbilled-charges.html#configuration)\n\
                    .  \n**Note:**\n`invoice_immediately`\nonly 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.\n\n.\n"
                  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 extended free of charge. The value is expressed in the time unit specified by `free_period_unit`. For example, `3` with `free_period_unit` = `month` adds 3 free months to the first term of the subscription.
                  minimum: 1
                  example: null
                free_period_unit:
                  type: string
                  deprecated: false
                  description: "The time unit for `free_period`.  \n\n**Constraints**\n\
                    Must be equal to or lower than the [`period_unit`](/docs/api/item_prices#period_unit)\
                    \ of the plan [item price](/docs/api/subscriptions/create-subscription-for-items#subscription_items_item_price_id)\
                    \ of the subscription.\n\n* week - Charge based on week(s)\n*\
                    \ month - Charge based on month(s)\n* day - Charge based on day(s)\n\
                    * year - Charge based on year(s)\n"
                  enum:
                  - day
                  - week
                  - month
                  - year
                  example: null
                contract_term_billing_cycle_on_renewal:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as `billing_cycles`
                    or a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)
                    .
                  maximum: 100
                  minimum: 1
                  example: null
                create_pending_invoices:
                  type: boolean
                  deprecated: false
                  description: |
                    Indicates whether the invoices for this subscription are generated with a `pending` `status`. This attribute is set to `true` automatically when the subscription has item prices that belong to `metered` items.
                    You can also set this to `true` explicitly using the [create](/docs/api/subscriptions/create-subscription-for-items#create_pending_invoices)/[update](/docs/api/subscriptions/update-subscription-for-items#create_pending_invoices) subscription operations. This is useful in the following scenarios:

                    * When tracking usages and calculating usage-based charges on your end. You can then add them to the subscription as a [one-time charge](https://www.chargebee.com/docs/charges.html) at the end of the billing term.
                    * When you need to inspect all charges before closing invoices for this subscription. Applicable only when [Metered Billing](https://www.chargebee.com/docs/metered_billing.html) is enabled for the site .
                  example: null
                auto_close_invoices:
                  type: boolean
                  deprecated: false
                  description: |
                    Set to `false`
                    to override for this subscription, the [site-level setting](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing)
                    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 [customer level](/docs/api/customers/customer-object#auto_close_invoices)
                    .
                  example: null
                first_invoice_pending:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    If you want to bill the usages from the previous billing cycle, set this parameter to `true`. This is useful if the subscription has moved from another system into Chargebee and you haven't closed the previous cycle's invoice yet. This creates a `pending` invoice immediately on subscription creation, to which you can [add usages](/docs/api/usages/create-a-usage) for the previous cycle.
                    If any non-`metered` items are present for the current term, they're also added to this `pending` invoice. As with all `pending` invoices, this invoice is also [closed automatically](https://www.chargebee.com/docs/metered_billing.html#configuring-metered-billing) or via an [API call](/docs/api/invoices/close-a-pending-invoice). This parameter can be passed only when the `create_pending_invoices` is `true`
                    .
                  example: null
                trial_end_action:
                  type: string
                  deprecated: false
                  description: |
                    Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/2.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/2.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/2.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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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/2.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
                        * dotpay - dotpay
                        * faster_payments - Faster Payments
                        * upi - upi
                        * kbc_payment_button - KBC Payment Button
                        * klarna - Payments made via Klarna.
                        * 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
                        * picpay - Payments made via PicPay.
                        * ovo - Payments made via OVO.
                        * boleto - boleto
                        * wechat_pay - Payments made via WeChat Pay.
                        * after_pay - Payments made via Afterpay
                        * grab_pay - Payments made via GrabPay
                        * mercado_pago - Payments made via Mercado Pago.
                        * direct_debit - direct_debit
                        * sepa_instant_transfer - Sepa Instant Transfer
                        * bancontact - bancontact
                        * touch_n_go - Payments made via Touch 'n Go.
                        * qpay - Payments made via Qpay.
                        * momo - Payments made via MoMo.
                        * affirm_pay - Payments made via Affirm Pay.
                        * kakao_pay - Payments made via Kakao Pay.
                        * blik - Payments made via BLIK.
                        * dana - Payments made via Dana.
                        * south_korean_cards - Payments made via South Korean Cards
                        * swish - Payments made via Swish
                        * thai_qr - Payments made via Thai QR.
                        * 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.
                        * tamara - Payments made via Tamara.
                        * pay_to - PayTo
                        * pay_co - Payments made via PayCo
                        * cash_app_pay - Payments made via Cash App Pay.
                        * rakuten_pay - Payments made via Rakuten Pay.
                        * alipay_hk - Payments made via Alipay HK.
                        * netbanking_emandates - netbanking_emandates
                        * nequi - Payments made via Nequi.
                        * paypay - PayPay
                        * payconiq_by_bancontact - Payments made via Payconiq by Bancontact.
                        * p24 - Payments made via Przelewy24 (P24).
                        * electronic_payment_standard - Electronic Payment Standard
                        * wero - Payments made via Wero.
                        * pay_by_bank - Pay By Bank
                        * apple_pay - apple_pay
                        * online_banking_poland - Online Banking Poland
                        * gcash - Payments made via GCash.
                        * nupay - Payments made via NuPay.
                        * giropay - giropay
                        * sofort - sofort
                        * amazon_payments - Amazon Payments
                        * fpx - Payments made via FPX.
                        * 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
                      - alipay_hk
                      - paypay
                      - gcash
                      - south_korean_cards
                      - paynow
                      - bizum
                      - promptpay
                      - dana
                      - touch_n_go
                      - tamara
                      - qpay
                      - ovo
                      - momo
                      - mercado_pago
                      - nequi
                      - nupay
                      - picpay
                      - thai_qr
                      - blik
                      - fpx
                      - wero
                      - p24
                      - affirm_pay
                      - rakuten_pay
                      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: |
                        * `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal).

                          * `payer`: User related information.
                            * `country_of_residence`: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a [two-character ISO code](https://docs.checkout.com/resources/codes/country-codes).
                            * `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
                        * `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
                        * `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user's `device_session_id` can be added to perform [additional validation](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                            * `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
                        * `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
                        * `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                        * `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.

                          * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
                        * `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.

                          * `payer`: User related information.
                            * `document`: Document is the user's identification number based on their country.
                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device
                      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: |
                        Action to be taken when the contract term completes.

                        * cancel - Contract term completes and subscription is canceled.
                        * evergreen - Contract term completes and the subscription renews.
                        * renew -
                          * Contract term completes and a new contract term is started for the number of billing cycles specified in [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).
                          * The `action_at_term_end` for the new contract term is set to `renew`.
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      default: 0
                      deprecated: false
                      description: |
                        The number of days before [`contract_end`](/docs/api/contract_terms/contract_term-object#contract_end)
                        , 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.
                      example: null
                  example: null
                billing_override:
                  type: object
                  deprecated: false
                  description: |
                    Specify limits on how credits and payments are applied to individual invoices for the subscription. 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 enable this feature. Note: These limits do not apply to [consolidated invoices](https://www.chargebee.com/docs/2.0/consolidated-invoicing.html)
                    .
                  properties:
                    max_excess_payment_usage:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Maximum amount of [excess payments](/docs/api/customers/customer-object#excess_payments) that can be automatically applied to a single invoice associated with this subscription.

                        **Supported values:**

                        * `-1`: Set to `-1` to reset the subscription-level limit. In this case, the site-level configuration will apply, whether it is configured to Auto Apply or Do Not Auto Apply excess payments.
                        * `0`: Disable auto-application for the subscription. No excess payments will be automatically applied to invoices.
                        * Any positive value: Specifies the maximum amount of excess payments that can be automatically applied to a single invoice for this subscription.
                      minimum: -1
                      example: null
                    max_refundable_credits_usage:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Maximum amount of [refundable credits](/docs/api/customers/customer-object#refundable_credits) that can be automatically applied to a single invoice associated with this subscription.

                        **Supported values:**

                        * `-1`: Set to `-1` to reset the subscription-level limit. In this case, the site-level configuration will apply, whether it is configured to Auto Apply or Do Not Auto Apply refundable credits.
                        * `0`: Disable auto-application for the subscription. No refundable credits will be automatically applied to invoices.
                        * Any positive value: Specifies the maximum amount of refundable credits that can be automatically applied to a single invoice for this subscription.
                      minimum: -1
                      example: null
                  example: null
                subscription_items:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription_items
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The unique identifier of the item price.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        The quantity of the item purchased
                      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 item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)
                        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: |
                        For the plan-item price:
                        the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then [the value set](/docs/api/item_prices/item-price-object)
                        for the plan-item price is used.

                        For addon-item prices:
                        If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)
                        are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then [the value set under attached addons](/docs/api/attached_items/attached-item-object)
                        is used. Further, if that value is not provided, then [the value set for the addon-item price](/docs/api/item_prices/item-price-object)
                        is used.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    trial_end:
                      type: array
                      description: |
                        The date/time when the trial period of the item ends. Applies to plan-items and--when [enabled](https://www.chargebee.com/docs/2.0/addons-trial.html)
                        --addon-items as well.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    service_period_days:
                      type: array
                      description: |
                        The service period of the item in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 730
                        minimum: 1
                        example: null
                      example: null
                    charge_on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          When `charge_on_option`
                          option is set to `on_event`
                          , this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.

                          * contract_termination -
                            when a contract term is [terminated](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option)
                            .
                          * subscription_trial_start - the time when the trial period of the subscription begins.
                          * subscription_activation -
                            the moment a subscription enters an `active`
                            or `non-renewing`
                            state. Also includes reactivations of canceled subscriptions.
                          * plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                          * subscription_creation - the time of creation of the subscription.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        Indicates if the charge-item is to be charged only once or each time the `charge_on_event`
                        occurs. This parameter only applies to charge-items.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    description:
                      type: array
                      description: "**Limited availability**\n\nSubscription-level\
                        \ item descriptions are available only on sites where this\
                        \ feature is enabled. Please reach out to the 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\nA description for this item that\
                        \ applies only to this subscription. When set, it is used\
                        \ on the customer-facing invoice instead of the description\
                        \ configured for the item price, and is returned as `entity_description`\
                        \ on the invoice [line item](/docs/api/invoices/invoice-object#invoice_line_items).\
                        \ When not set, the description configured for the item price\
                        \ is used.  \n**Constraints**\n\n* Maximum 500 characters.\n\
                        * Whether a description is shown on the invoice at all continues\
                        \ to be controlled by the item price's [show_description_in_invoices](/docs/api/item_prices#show_description_in_invoices)\
                        \ setting. This parameter determines which description is\
                        \ shown, not whether one is shown.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 500
                        example: null
                      example: null
                    charge_on_option:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates when the charge-item is to be charged. This parameter only applies to charge-items.

                          * immediately - The item is charged immediately on being added to the subscription.
                          * on_event -
                            The item is charged at the occurrence of the event specified as `charge_on_event`
                            .
                        enum:
                        - immediately
                        - on_event
                        example: null
                      example: null
                    usage_accumulation_reset_frequency:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Specifies the frequency at which the usage counter needs to be reset.

                          * subscription_billing_frequency - Accumulates usage until the subscription's billing frequency ends.
                          * never - Accumulates usage without ever resetting it.
                        enum:
                        - never
                        - subscription_billing_frequency
                        example: null
                      example: null
                  required:
                  - item_price_id
                  example: null
                discounts:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for discounts
                  properties:
                    apply_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The amount on the invoice to which the discount is applied.

                          * invoice_amount -
                            The discount is applied to the invoice `sub_total`
                            .
                          * specific_item_price -
                            The discount is applied to the `invoice.line_item.amount`
                            that corresponds to the item price specified by `item_price_id`
                            .
                        enum:
                        - invoice_amount
                        - specific_item_price
                        example: null
                      example: null
                    duration_type:
                      type: array
                      items:
                        type: string
                        default: forever
                        deprecated: false
                        description: |
                          Specifies the time duration for which this discount is attached to the subscription.

                          * 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 `period`
                            and `period_unit`
                            .
                          * forever -
                            The discount is attached to the subscription and applied on the invoices till it is [explicitly removed](/docs/api/subscriptions/update-subscription-for-items#discounts_operation_type)
                            .
                          * one_time -
                            The discount stays attached to the subscription till it is applied on an invoice **once**.
                            It is removed after that from the subscription.
                        enum:
                        - one_time
                        - forever
                        - limited_period
                        example: null
                      example: null
                    percentage:
                      type: array
                      description: |
                        The percentage of the original amount that should be deducted from it.
                      items:
                        type: number
                        format: double
                        deprecated: false
                        maximum: 100
                        minimum: 0.01
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        The value of the discount. [The format of this value](/docs/api/currencies)
                        depends on the kind of currency.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    period:
                      type: array
                      description: |
                        The duration of time for which the discount is attached to the subscription, in `period_units`.
                        Applicable only when `duration_type`
                        is `limited_period`.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    period_unit:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The unit of time for `period`.
                          Applicable only when `duration_type`
                          is `limited_period`.

                          * week - A period of 7 days.
                          * year - A period of 1 calendar year.
                          * day - A period of 24 hours.
                          * month - A period of 1 calendar month.
                        enum:
                        - day
                        - week
                        - month
                        - year
                        example: null
                      example: null
                    included_in_mrr:
                      type: array
                      description: |
                        The discount is included in MRR calculations for your site. This attribute is only applicable when `duration_type`
                        is `one_time`
                        and when the [feature is enabled](https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation)
                        in Chargebee. Also, If the [site-level setting](https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation)
                        is to exclude one-time discounts from MRR calculations, this value is always returned `false`.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    item_price_id:
                      type: array
                      description: |
                        The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                        in the subscription to which the discount is to be applied. Relevant only when `apply_on`
                        = `specific_item_price`.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Specifies the number of free units provided for the item, without affecting the total quantity sold
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                  required:
                  - duration_type
                  example: null
                item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_tiers
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The id of the item price for which the tier price is being overridden.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: |
                        The lowest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The highest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |
                        The overridden price of the tier. The value depends on the [type of currency](/docs/api/subscriptions)
                        .
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    pricing_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Pricing type for the tier.

                          * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                          * flat_fee -
                            Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                            pricing model, `pricing_type`
                            will be set to `flat_fee`
                            by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                          * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                        enum:
                        - per_unit
                        - flat_fee
                        - package
                        example: null
                      example: null
                    package_size:
                      type: array
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              billing_override:
                style: deepObject
                explode: true
              contract_term:
                style: deepObject
                explode: true
              discounts:
                style: deepObject
                explode: true
              item_tiers:
                style: deepObject
                explode: true
              payment_intent:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              statement_descriptor:
                style: deepObject
                explode: true
              subscription_items:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                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
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: |
                      Resource object representing invoice
                  unbilled_charges:
                    type: array
                    description: |
                      Resource object representing unbilled_charge
                    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}/import_unbilled_charges:
    post:
      tags:
      - subscriptions
      summary: Import unbilled charges
      description: "Imports one or more [unbilled charges](/docs/api/unbilled_charges)\
        \ into an existing subscription. Use this operation to add usage-based or\
        \ other unbilled charges recorded in external systems to the subscription.\
        \  \n\n### Prerequisites \\& Constraints\n\nIf you are trying to use this\
        \ operation on your live site, ensure you have requested [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 it, otherwise the API will return an \"API not enabled\" error.\
        \  \n\n### Impacts\n\n**Invoicing**  \n* Unbilled charges on the subscription\
        \ are automatically invoiced on the next renewal.\n* You can also invoice\
        \ unbilled charges on-demand using the [Create an invoice for unbilled charges\
        \ API](/docs/api/unbilled_charges/create-an-invoice-for-unbilled-charges).\
        \  \n**Accounting Integrations**  \nImported unbilled charges will not sync\
        \ with your [accounting integration](https://www.chargebee.com/docs/billing/2.0/integrations/finance-integration-index)\
        \ until they are invoiced.\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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.

                          * 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
                          * adhoc - Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case
                          * plan_item_price - Indicates that this line item is based on plan Item Price
                        enum:
                        - adhoc
                        - plan_item_price
                        - addon_item_price
                        - charge_item_price
                        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: |
                        The decimal representation of the amount for the charge, in major units of the currency. Typically equals to `unit_amount_in_decimal`
                        x `quantity_in_decimal`.
                        Returned when [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      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/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/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: |
                          The type of deduction and the amount to which it is applied.

                          * document_level_coupon -
                            The deduction is due to a coupon applied to the invoice `sub_total`.
                            The coupon id is passed as `entity_id`
                            .
                          * item_level_coupon -
                            The deduction is due to a coupon applied to line item. The coupon `id`
                            is passed as `entity_id`
                            .
                          * document_level_discount -
                            The deduction is due to a [discount](/docs/api/discounts)
                            applied to the invoice `sub_total`.
                            The discount `id`
                            is available as the `entity_id`.
                          * item_level_discount -
                            The deduction is due to a [discount](/docs/api/discounts)
                            applied to a line item of the invoice. The discount `id`
                            is available as the `entity_id`.
                        enum:
                        - item_level_coupon
                        - document_level_coupon
                        - item_level_discount
                        - document_level_discount
                        example: null
                      example: null
                    entity_id:
                      type: array
                      description: |
                        When the deduction is due to a `coupon`
                        , then this is the `id`
                        of the coupon. Is required when `discounts[entity_type]`
                        is `item_level_coupon`
                        or `document_level_coupon`
                        .
                      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: |
                        The price of the tier if the charge model is a `stairtstep`
                        pricing , or the price of each unit in the tier if the charge model is `tiered`
                        /`volume`
                        pricing.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the `line_items.pricing_model`
                        is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the `line_items.pricing_model`
                        is `tiered`
                        , `volume`
                        or stairstep and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    quantity_used_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity purchased from this tier. Returned when the `line_item`
                        is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_amount_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for `line_item`.
                        The value is in major units of the currency. Returned when the `line_item`
                        is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      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: |
                      Resource object representing unbilled_charge
                    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:
      tags:
      - subscriptions
      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**.  \n**Warning**\nThis API will return an error when [multi-frequency\
        \ billing](/docs/api/subscriptions) is enabled.\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      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
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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:
      tags:
      - subscriptions
      summary: Retrieve a subscription
      description: |
        Retrieves a subscription.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      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
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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:
      tags:
      - subscriptions
      summary: Import contract term
      description: "Imports an active or historical [contract term](/docs/api/contract_terms)\
        \ for a subscription.\n\nUse this operation to import contract terms when\
        \ migrating subscriptions from another billing system, or to add historical\
        \ contract term data for existing subscriptions. You can import both active\
        \ contract terms (currently running) and historical contract terms (completed,\
        \ canceled, or terminated).  \n\n### Prerequisites \\& Constraints\n\n* The\
        \ [Contract Terms](https://www.chargebee.com/docs/billing/2.0/subscriptions/contract-terms)\
        \ feature must be enabled on the site.\n* The [Multi-Frequency Billing](https://www.chargebee.com/docs/billing/2.0/subscriptions/subscriptions#multi-frequency-billing)\
        \ feature must not be enabled for the site.\n* The subscription must have\
        \ a fixed billing cycle (the [`remaining_billing_cycles`](/docs/api/subscriptions#remaining_billing_cycles)\
        \ must be set).\n* The contract term period must not overlap with any existing\
        \ contract terms for the subscription.  \n\n### Impacts\n\n**Contract term**\
        \  \n* A new `contract_term` resource is created and [associated](/docs/api/subscriptions#contract_term)\
        \ with the subscription.\n* For active contract terms:\n* the `total_contract_value`\
        \ is calculated as the sum of the contract estimate and the `total_amount_raised`\
        \ parameter.\n* The `contract_end` date is calculated based on the `contract_start`\
        \ date and the `billing_cycle` parameter.  \n\n### Implementation Notes\n\n\
        * Check the subscription's `remaining_billing_cycles` attribute. If it is\
        \ not set, the subscription is set to forever renewal. [Update the subscription](subscriptions#update_subscription_for_items_billing_cycles)\
        \ to a fixed billing cycle before importing a contract term.\n* [Check for\
        \ existing contract terms](subscriptions#list_contract_terms_for_a_subscription)\
        \ for the subscription. Ensure that the the `contract_start` and `contract_end`\
        \ dates don't overlap with any existing contract term for the subscription.\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: "The number of billing cycles the new contract term\
                    \ should run for when the contract term renews. This value is\
                    \ used when `action_at_term_end` is `renew` or `renew_once`. \
                    \ \n**Constraints**\n\n* Should not be sent when `action_at_term_end`\
                    \ is `cancel` or `evergreen`.  \n**Default value**\n\n* Defaults\
                    \ to the value of `billing_cycle` or a custom value depending\
                    \ on the [site configuration](https://www.chargebee.com/docs/billing/2.0/subscriptions/contract-terms#configuring-contract-terms).\n"
                  maximum: 100
                  minimum: 1
                  example: null
                contract_term:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for contract_term
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: "Unique identifier for the contract term in the\
                        \ site.  \n**Default value**\n\n* If not provided, a unique\
                        \ identifier is automatically generated.\n"
                      maxLength: 50
                      example: null
                    created_at:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: "The date when the contract term was created. \
                        \ \n**Required if**\n\n* The contract term `status` is `active`.\
                        \  \n**Constraints**\n\n* For active contract terms, cannot\
                        \ be a future date unless the subscription `status` is `future`.\n\
                        * Must be less than or equal to `contract_start`.  \n**Default\
                        \ value**\n\n* For historical contract terms, defaults to\
                        \ `contract_start` if not provided.\n"
                      example: null
                    contract_start:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: "The start date of the contract term.  \n**Constraints**\n\
                        \n* Must be less than `contract_end`.\n* For active contract\
                        \ terms, cannot be a future date unless the subscription `status`\
                        \ is `future`.\n* For historical contract terms, must be a\
                        \ past date.\n* Cannot be less than `created_at`.\n* Must\
                        \ not overlap with existing contract terms for the subscription.\n"
                      example: null
                    contract_end:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: "The end date of the contract term.  \n**Required\
                        \ if**\n\n* The contract term `status` is not `active` (for\
                        \ historical contract terms).  \n**Constraints**\n\n* Should\
                        \ not be sent when the contract term `status` is `active`\
                        \ (it is calculated automatically).\n* Must be greater than\
                        \ `contract_start`.\n* Must be a past date.\n* Must not overlap\
                        \ with existing contract terms for the subscription.\n"
                      example: null
                    status:
                      type: string
                      deprecated: false
                      description: "Current status of the contract term. Use `active`\
                        \ for currently running contract terms, or `completed`, `cancelled`,\
                        \ or `terminated` for historical contract terms.\n\n* active\
                        \ -\n  An actively running contract term.  \n  **Prerequisite**\n\
                        \n  * The subscription `status` must be `future`, `in_trial`,\
                        \ `active`, or `non-renewing`.\n* completed - The contract\
                        \ term has run its full duration.\n* cancelled - The contract\
                        \ term was ended because a change in the subscription caused\
                        \ a [subscription term reset](/docs/api/subscriptions/update-subscription-for-items#force_term_reset),\
                        \ or the subscription was canceled due to non-payment.\n*\
                        \ terminated - The contract term was terminated ahead of completion.\n"
                      enum:
                      - active
                      - completed
                      - cancelled
                      - terminated
                      example: null
                    total_amount_raised:
                      type: integer
                      format: int64
                      default: 0
                      deprecated: false
                      description: "The amount raised for the contract term up to\
                        \ the time of importing the subscription. This amount is added\
                        \ to the contract estimate to calculate the [`total_contract_value`](/docs/api/contract_terms#total_contract_value)\
                        \ for active contract terms.  \n**Required if**\n\n* The contract\
                        \ term `status` is `active`.  \n**Constraints**\n\n* Should\
                        \ not be sent when the contract term `status` is not `active`.\n"
                      minimum: 0
                      example: null
                    total_amount_raised_before_tax:
                      type: integer
                      format: int64
                      default: 0
                      deprecated: false
                      description: "The amount raised for the contract term up to\
                        \ the time of importing the subscription, excluding tax. This\
                        \ amount is added to the contract estimate to calculate the\
                        \ [`total_contract_value_before_tax`](contract_terms#contract_term_total_contract_value_before_tax)\
                        \ for active contract terms.  \n**Required if**\n\n* The contract\
                        \ term `status` is `active` and [pre-tax TCV](https://www.chargebee.com/docs/contract-terms.html)\
                        \ is enabled on the site.  \n**Constraints**\n\n* Should not\
                        \ be sent when the contract term `status` is not `active`.\n"
                      minimum: 0
                      example: null
                    total_contract_value:
                      type: integer
                      format: int64
                      default: 0
                      deprecated: false
                      description: "The sum of the [totals](/docs/api/invoices#total)\
                        \ of all invoices raised as part of the contract term.\nFor\
                        \ active contract terms, this is a predicted value calculated\
                        \ as the sum of the contract estimate and `total_amount_raised`.\
                        \  \n**Required if**\n\n* The contract term `status` is not\
                        \ `active` (for historical contract terms).  \n**Constraints**\n\
                        \n* Should not be sent when the contract term `status` is\
                        \ `active` (it is calculated automatically).\n"
                      minimum: 0
                      example: null
                    total_contract_value_before_tax:
                      type: integer
                      format: int64
                      default: 0
                      deprecated: false
                      description: "The total amount of revenue expected to be generated\
                        \ from the contract term, calculated as the sum of all invoices\
                        \ raised during the term, excluding taxes. For active contract\
                        \ terms, this is calculated as the sum of the contract estimate\
                        \ (before tax) and `total_amount_raised_before_tax`.  \n**Required\
                        \ if**\n\n* The contract term `status` is not `active` and\
                        \ [pre-tax TCV](https://www.chargebee.com/docs/contract-terms.html)\
                        \ is enabled on the site (for historical contract terms).\
                        \  \n**Constraints**\n\n* Should not be sent when the contract\
                        \ term `status` is `active` (it is calculated automatically).\n"
                      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 covers.  \n**Required if**\n\n* The\
                        \ contract term `status` is `active`.  \n**Constraints**\n\
                        \n* For active contract terms, must be greater than the subscription's\
                        \ `remaining_billing_cycles` when the subscription `status`\
                        \ is `active` or `non-renewing`.  \n**Default value**\n\n\
                        * For historical contract terms, defaults to `1` if not provided.\n"
                      minimum: 0
                      example: null
                    action_at_term_end:
                      type: string
                      default: renew
                      deprecated: false
                      description: |
                        Action to be taken when the contract term completes.

                        * evergreen - The contract term completes and the subscription continues to renew without a new contract term.
                        * renew_once - The contract term completes and a new contract term is started for the number of billing cycles specified in `contract_term_billing_cycle_on_renewal`. The `action_at_term_end` for the new contract term is set to `cancel`, so the subscription is canceled when the new contract term completes.
                        * cancel - The contract term completes and the subscription is canceled.
                        * renew - The contract term completes and a new contract term is started for the number of billing cycles specified in `contract_term_billing_cycle_on_renewal`. The `action_at_term_end` for the new contract term is set to `renew`.
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      - renew_once
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      deprecated: false
                      description: "The number of days before `contract_end` during\
                        \ which the customer is barred from canceling the contract\
                        \ term. The customer can cancel the contract term via the\
                        \ [Self-Serve Portal](https://www.chargebee.com/docs/self-serve-portal.html)\
                        \ only before this period. This allows you to have sufficient\
                        \ time for processing the contract term closure.  \n**Required\
                        \ if**\n\n* The `action_at_term_end` is `renew` or `renew_once`.\
                        \  \n**Constraints**\n\n* Must be less than the duration of\
                        \ the contract term (in days).\n* Should not be sent when\
                        \ `action_at_term_end` is `cancel` or `evergreen`.\n"
                      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: |
                      Resource object representing contract_term
                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:
      tags:
      - subscriptions
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing subscription
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: |
                      Resource object representing payment_source
                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:
      tags:
      - subscriptions
      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.  \n**Warning**\nThis API will\
        \ return an error when [multi-frequency billing](/docs/api/subscriptions)\
        \ is enabled.\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      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
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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:
      tags:
      - subscriptions
      summary: Edit advance invoice schedule
      description: |
        **Caution**
        This API will return an error when [multi-frequency billing](/docs/api/subscriptions#subscription-billing-frequencies) is enabled.

        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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                        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 [`remaining_billing_cycles`](/docs/api/subscriptions/subscription-object#remaining_billing_cycles)
                        of the subscription. This parameter is applicable only when [`fixed_interval_schedule[end_schedule_on]`](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#fixed_interval_schedule_end_schedule_on)
                        = `after_number_of_intervals`
                      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: |
                        Specifies when the schedule should end.

                        * after_number_of_intervals - Advance invoices are generated a `specified number of times`
                        * subscription_end - Advance invoices are generated for as long as the subscription is active.
                        * specific_date -
                          End the advance invoicing schedule on a `specific date`
                          .
                      enum:
                      - after_number_of_intervals
                      - specific_date
                      - subscription_end
                      example: null
                    end_date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        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 [`fixed_interval_schedule[end_schedule_on]`](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#fixed_interval_schedule_end_schedule_on)
                        = `specific_date`
                        .
                      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: |
                        The number of billing cycles to charge for, on the date specified. Applicable only when [`schedule_type`](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#schedule_type)
                        is specific_dates.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    date:
                      type: array
                      description: |
                        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 [`schedule_type`](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#schedule_type)
                        is `specific_dates`
                        .
                      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: |
                      Resource object representing advance_invoice_schedule
                    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}/discounts:
    get:
      tags:
      - subscriptions
      summary: List discounts for a subscription
      description: "Retrieves a list of [discount](/docs/api/discounts)\nresources\
        \ [currently attached](/docs/api/subscriptions/subscription-object#discounts)\n\
        to a specific subscription. The list is sorted in descending order based on\
        \ the [created_at](/docs/api/discounts/discount-object#created_at)\ntimestamp.\
        \  \n**Note**\nThis endpoint does not return [coupon](/docs/api/coupons) or\
        \ [coupon_code](/docs/api/coupon_codes) resources.\n"
      operationId: list_discounts_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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        discount:
                          $ref: "#/components/schemas/Discount"
                          description: Resource object representing discount
                      required:
                      - discount
                      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}/contract_terms:
    get:
      tags:
      - subscriptions
      summary: List contract terms for a subscription
      description: "Retrieves a list of contract term resources for the subscription\
        \ specified in the path.  \n**Warning**\nThis API will return an error when\
        \ [multi-frequency billing](/docs/api/subscriptions) is enabled.\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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:
      tags:
      - subscriptions
      summary: Pause a subscription
      description: "Use this API to pause an active or non-renewing subscription.\
        \ When a subscription is paused, it does not renew, and Chargebee does not\
        \ generate renewal [invoices](/docs/api/invoices) for it. This allows you\
        \ to temporarily suspend a customer's service without canceling the subscription.\
        \  \n\n### Prerequisites \\& Constraints\n\n* The [Pause Subscription](https://www.chargebee.com/docs/2.0/pause-subscription.html#configure-pause-resume-subscription)\
        \ feature must be enabled for the site.\n* Only subscriptions in the `active`\
        \ or `non_renewing` state can be paused.\n* Subscriptions with [active contract_terms](/docs/api/contract_terms/contract_term-object#status)\
        \ cannot be paused.  \n\n### Impacts\n\n**Subscription**  \nIf the `pause_option`\
        \ parameter is set to `immediately`, the subscription's `status` changes to\
        \ `paused`. The `next_billing_at`, `pause_date`, and `resume_date` values\
        \ are updated based on the input parameters.  \n**Unbilled Charges**  \nIf\
        \ the subscription has [unbilled charges](/docs/api/unbilled_charges) and\
        \ is paused immediately, you can choose to leave the charges unbilled or invoice\
        \ them. If invoiced, Chargebee attempts payment collection based on the customer's\
        \ auto-collection settings. If payment fails or auto-collection is not enabled,\
        \ the invoice is marked as unpaid.\n\nUse the `unbilled_charges_handling`\
        \ parameter to set your preference.  \n**Dunning**  \nIf the subscription\
        \ has unpaid invoices in [dunning](https://www.chargebee.com/docs/payments/2.0/dunning/dunning-v2)\
        \ and is paused immediately, you can choose to either stop or continue the\
        \ dunning process.\n\nUse the `invoice_dunning_handling` parameter to set\
        \ your preference.  \n**Scheduled Ramps**  \nAny future [subscription ramps](/docs/api/ramps)\
        \ (such as price or quantity changes) effective on or after the pause date\
        \ are automatically deleted.  \n**Advanced Invoices**  \nIf the subscription\
        \ has an [advance invoice](/docs/api/subscriptions/charge-future-renewals),\
        \ Chargebee creates an adjustment credit note if the invoice is unpaid or\
        \ in a payment-due state. If the invoice is already paid, a refundable credit\
        \ note is created.  \n\n### Implementation Notes\n\nBefore calling this API,\
        \ perform the following checks:\n\n* Confirm that the subscription `status`\
        \ is `active` or `non_renewing`. If it isn't, the API returns an `invalid_state_for_pause`\
        \ error.\n* Check the `has_scheduled_changes` attribute. If `true`, either\
        \ remove the scheduled changes before calling the API or avoid the operation.\
        \ Otherwise, the API returns an `operation_failed` error.\n* Ensure that the\
        \ `contract_term` attribute is not present, or if it is present, that `contract_term.status`\
        \ is not `active`. Otherwise, the API returns an `invalid_request` error.\n\
        * If a subscription is in the `non_renewing` state and you want to set the\
        \ [pause date](/docs/api/subscriptions/pause-a-subscription#pause_date) to\
        \ a future date, the pause date must be earlier than the [cancellation date](/docs/api/subscriptions).\
        \ If you specify a [resume date](/docs/api/subscriptions/pause-a-subscription#resume_date),\
        \ it must also be earlier than the cancellation date.\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    List of options to pause the subscription.

                    * billing_cycles - Pause at the end of the current term, and resume automatically after the set number of billing cycles (in [skip_billing_cycles](/docs/api/subscriptions/pause-a-subscription#skip_billing_cycles)) have been skipped
                    * immediately - Pause immediately
                    * end_of_term - Pause at the end of current term
                    * specific_date - Pause on a specific date
                  enum:
                  - immediately
                  - end_of_term
                  - specific_date
                  - billing_cycles
                  example: null
                pause_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    Date on which the subscription will be paused. Applicable when `specific_date` option is chosen in the [pause_option](/docs/api/subscriptions/pause-a-subscription#pause_option) field.
                    For non-renewing subscriptions, `pause_date` should be before the cancellation date.
                  example: null
                unbilled_charges_handling:
                  type: string
                  deprecated: false
                  description: |
                    Applicable when unbilled charges are present for the subscription and [pause_option](/docs/api/subscriptions/pause-a-subscription#pause_option) is set as `immediately`. **Note:** On the invoice raised, an automatic charge is attempted on the payment method available, if customer's auto-collection property is set to `on`.

                    * invoice -
                      Invoice charges
                      If `invoice` 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.
                    * no_action -
                      Retain as unbilled
                      If `no_action` is chosen, charges are added to the resumption invoice.
                  enum:
                  - no_action
                  - invoice
                  example: null
                invoice_dunning_handling:
                  type: string
                  deprecated: false
                  description: |
                    Handles dunning for invoices already in the dunning cycle when a subscription is paused. Applicable when [pause_option](/docs/api/subscriptions/pause-a-subscription#pause_option) is set as `immediately`.
                    If invoice is in the dunning cycle, `invoice_dunning_handing` allows you to `stop` or `continue` dunning.

                    * continue - Continue dunning
                    * stop - Stop dunning
                  enum:
                  - continue
                  - stop
                  example: null
                skip_billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    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 [pause_option](/docs/api/subscriptions/pause-a-subscription#pause_option)
                    is `billing_cycles`
                    .
                  minimum: 1
                  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.
                    For non-renewing subscriptions,`resume_date` should be before the cancellation date.
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                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
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: |
                      Resource object representing invoice
                  unbilled_charges:
                    type: array
                    description: |
                      Resource object representing unbilled_charge
                    items:
                      $ref: "#/components/schemas/UnbilledCharge"
                      description: Resource object representing unbilled_charge
                    example: null
                  credit_notes:
                    type: array
                    description: |
                      Resource object representing credit_note
                    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:
      tags:
      - subscriptions
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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_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:
      tags:
      - subscriptions
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
      tags:
      - customers
      summary: Delete a customer
      description: "Deletes a specified customer.\n\nThis operation schedules the\
        \ customer resource for deletion, and it is **permanently** deleted after\
        \ a few minutes.\n\nIf you wish to retain the customer data but stop further\
        \ subscription renewals, consider [canceling](/docs/api/subscriptions/cancel-subscription-for-items)\
        \ or [pausing](/docs/api/subscriptions/pause-a-subscription) the subscriptions\
        \ instead.  \n\n### Prerequisites \\& Constraints\n\n* The customer must not\
        \ be part of an [account hierarchy](/docs/api/hierarchies) (neither a parent\
        \ nor a child).\n* The customer record must not have any linked [gift subscriptions](/docs/api/gifts)\
        \ (neither gifter nor recipient).\n* None of the customer's [invoices](/docs/api/invoices)\
        \ may be paid by a different customer.\n* None of the customer's [credit notes](/docs/api/credit_notes)\
        \ may be allocated to an [invoice](/docs/api/invoices) that belongs to a different\
        \ customer.  \n\n### Impacts\n\n**Subscriptions**  \n* All the subscriptions\
        \ belonging to the customer are deleted.\n* See [Delete a subscription API](/docs/api/subscriptions/delete-a-subscription)\
        \ for more details on the impacts of deleting a subscription.  \n**Invoices**\
        \  \n* All the invoices belonging to the customer are deleted.\n* See [Delete\
        \ an invoice API](/docs/api/invoices/delete-an-invoice) for more details on\
        \ the impacts of deleting an invoice.  \n**Credit notes**  \n* All the credit\
        \ notes belonging to the customer are deleted.  \n**Payment sources**  \n\
        The [payment sources](/docs/api/payment_sources) linked to the customer are\
        \ deleted and also removed from the [payment gateway](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/gateway_settings).\
        \ To retain payment gateway records, pass `delete_payment_method` = `false`.\
        \  \n**Reports**  \n* The numbers in the following [reports](https://www.chargebee.com/docs/billing/2.0/reports-and-analytics/metric_description)\
        \ are modified when a customer is deleted: Payments, New Revenue, Signups,\
        \ Activations, Cancellations, and Refunds.  \n\n### Implementation Notes\n\
        \nBefore deleting a customer, ensure the following:\n\n* Check and remove\
        \ account hierarchy linkage:\n  1. Use the [Get hierarchy API](/docs/api/customers/get-hierarchy)\
        \ to check if the customer is part of an account hierarchy.\n  2. If the customer\
        \ is part of an account hierarchy, use the [Unlink a customer from its parent\
        \ account API](/docs/api/customers/delink-a-customer) to remove the customer\
        \ from the hierarchy.\n* Remove any payments by other customers:\n  1. Use\
        \ the [List invoices API](/docs/api/invoices/list-invoices) to retrieve all\
        \ the invoices for this customer.\n  2. For each invoice, look up all the\
        \ linked payments (`invoice.linked_payments[]`).\n  3. For each linked payment,\
        \ check if the payer (`transaction.customer_id`) is this customer.\n  4. If\
        \ not, use the [Remove payment from an invoice API](/docs/api/invoices/remove-payment-from-an-invoice)\
        \ to remove the payment from the invoice.\n* Remove credit note allocations\
        \ to other customers:\n  1. Use the [List credit notes API](/docs/api/credit_notes/list-credit-notes)\
        \ to retrieve all the credit notes for this customer.\n  2. For each credit\
        \ note, look up all the invoice allocations (`credit_note.allocations.invoice_id`).\n\
        \  3. For all such invoices, check if the associated customer (`invoice.customer_id`)\
        \ is this customer.\n  4. If not, use the [Remove credit note from an invoice\
        \ API](/docs/api/invoices/remove-credit-note-from-an-invoice) to remove the\
        \ allocation.\n* Remove credit note allocations from other customers:\n  1.\
        \ Use the [List invoices API](/docs/api/invoices/list-invoices) to retrieve\
        \ all the invoices for this customer.\n  2. For each invoice, look up all\
        \ the applied credit notes (`credit_note.applied_credits.cn_id`).\n  3. For\
        \ all such credit notes, check if the associated customer (`credit_note.customer_id`)\
        \ is this customer.\n4. If not, use the [Remove credit note from an invoice\
        \ API](/docs/api/invoices/remove-credit-note-from-an-invoice) to remove the\
        \ credit note allocation.  \n\n#### Related APIs\n\n[Pause a subscription](/docs/api/subscriptions?prod_cat_ver=2#pause_a_subscription)[Cancel\
        \ a subscription](/docs/api/subscriptions?prod_cat_ver=2#cancel_subscription_for_items)[Unlink\
        \ a customer from its parent account](/docs/api/customers?prod_cat_ver=2#delink_a_customer)\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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing customer
                  card:
                    $ref: "#/components/schemas/Card"
                    description: |
                      Resource object representing card
                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:
      tags:
      - customers
      summary: Link a customer to an account hierarchy
      description: "Creates a [hierarchical relationship](https://www.chargebee.com/docs/account-hierarchy.html)\
        \ between two customers. The path parameter `customer_id` identifies the child\
        \ in this relationship, and `parent_id` identifies the parent.  \n**Note**\n\
        \nFor the `use_default_hierarchy_settings`, `parent_account_access`, and `child_account_access`\
        \ parameters in this operation, the term \"parent\" usually refers to [`payment_owner_id`](/docs/api/customers/link-a-customer#payment_owner_id).\
        \ If `payment_owner_id` is the same as `customer_id`, then \"parent\" refers\
        \ to [`parent_id`](/docs/api/customers/link-a-customer#parent_id).  \n\n###\
        \ Prerequisites \\& Constraints\n\n* `customer_id` and `parent_id` must belong\
        \ to the same [business entity](/docs/api/advanced-features).\n* The [Account\
        \ Hierarchy limits](https://www.chargebee.com/docs/billing/2.0/customers/account-hierarchy#limits)\
        \ must not be exceeded due to this operation.  \n\n### Impacts\n\n**Customer**\
        \  \n* Sets the following attributes on the `customer` resource:\n  * [`relationship`](/docs/api/customers)\n\
        \  * [`use_default_hierarchy_settings`](/docs/api/customers)\n  * [`child_account_access`](/docs/api/customers)\n\
        * [`parent_account_access`](/docs/api/customers)  \n**Invoices**  \n* For\
        \ all invoices generated for `customer_id` after you link the customer, Chargebee\
        \ sets `invoice.customer_id` to `invoice_owner_id`.  \n**Transactions**  \n\
        * When Chargebee generates invoices for `customer_id`, if `auto_collection`\
        \ is `on` for `invoice_owner_id`, Chargebee uses the `payment_source` of the\
        \ `payment_owner_id` to pay the invoices and creates transactions for the\
        \ payment under `payment_owner_id`.  \n**RevenueStory**  \n* The [Customer\
        \ Insights](https://www.chargebee.com/docs/billing/2.0/reports-and-analytics/chargebee-analytics#customer-insights)\
        \ report in RevenueStory shows parent-level views for customers with hierarchy\
        \ relationships.\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    ID of the customer intended to be set as the immediate parent of the customer identified by `customer_id`
                    .
                  maxLength: 50
                  example: null
                payment_owner_id:
                  type: string
                  deprecated: false
                  description: "The `id` of the customer responsible for paying the\
                    \ invoices for the customer identified by `customer_id`.  \n**Constraints**\n\
                    \n* If the `invoice_owner_id` is the same as the `customer_id`,\
                    \ then the `payment_owner_id` can be the `customer_id` or an ancestor\
                    \ of the `customer_id`.\n* If the `invoice_owner_id` is not the\
                    \ same as the `customer_id`, then the `payment_owner_id` must\
                    \ be the `invoice_owner_id`.\n"
                  maxLength: 50
                  example: null
                invoice_owner_id:
                  type: string
                  deprecated: false
                  description: "The `id` of the customer who receives the invoice\
                    \ for charges incurred by the customer identified by `customer_id`.\
                    \  \n**Constraint**\n\n* This ID must match either `customer_id`\
                    \ or one of its ancestors.\n"
                  maxLength: 50
                  example: null
                use_default_hierarchy_settings:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |
                    Decides if Chargebee should apply settings from the [Chargebee Billing UI](https://www.chargebee.com/docs/2.0/account-hierarchy.html#advanced-mode) or from this API request.

                    * If set to `true`: Chargebee uses settings configured in the Chargebee Billing UI.
                    * If set to `false`: Settings provided in the `parent_account_access` and `child_account_access` parameters are applied.
                  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: |
                        If set to `true`
                        , the parent receives email notifications for the child's subscriptions.
                      example: null
                    send_payment_emails:
                      type: boolean
                      deprecated: false
                      description: |
                        If set to `true`
                        , the parent receives email notifications for payment-related activities on the child's invoices.
                      example: null
                    send_invoice_emails:
                      type: boolean
                      deprecated: false
                      description: |
                        If set to `true`
                        , the parent receives email notifications for the child's invoices.
                      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: |
                        If set to `true`
                        , the child account receives email notifications for its subscriptions.
                      example: null
                    send_payment_emails:
                      type: boolean
                      deprecated: false
                      description: |
                        If set to `true`
                        , the child account receives email notifications for payment-related activities for its invoices.
                      example: null
                    send_invoice_emails:
                      type: boolean
                      deprecated: false
                      description: |
                        If set to `true`
                        , the child account receives email notifications for its invoices.
                      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: |
                      Resource object representing customer
                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:
      tags:
      - customers
      summary: Unlink a customer from its parent account
      description: |
        When a customer belongs to an [account hierarchy](https://www.chargebee.com/docs/2.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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing customer
                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:
      tags:
      - customers
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing customer
                  card:
                    $ref: "#/components/schemas/Card"
                    description: |
                      Resource object representing card
                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:
      tags:
      - customers
      summary: Assign payment role
      description: "Assign or unassign the [primary](/docs/api/customers/customer-object#primary_payment_source_id)\
        \ or [backup](/docs/api/customers/customer-object#backup_payment_source_id)\
        \ payment role for a payment source.\n\n##### Set role when creating a payment\
        \ source\n\nYou can also assign a payment source as primary when you create\
        \ it using APIs such as:\n\n* [Create a payment source using payment intent](/docs/api/payment_sources/create-using-payment-intent)\n\
        * [Create a payment source using temporary token](/docs/api/payment_sources/create-using-gateway-temporary-token)\n\
        * [Create a payment source using permanent token](/docs/api/payment_sources/create-using-chargebee-token)\n\
        \n##### Payment collection precedence\n\nChargebee uses the following precedence\
        \ to determine which payment source to use when it collects payments for a\
        \ [subscription](/docs/api/subscriptions/list-subscriptions):\n\n* The [payment\
        \ source](/docs/api/subscriptions/subscription-object#payment_source_id) attached\
        \ to the subscription, if available.\n* The primary payment source of the\
        \ customer.\n* The backup payment source of the customer, if available.  \n\
        \n### Prerequisites \\& Constraints\n\n* The payment source must belong to\
        \ the customer and must not be [`deleted`](/docs/api/payment_sources/payment_source-object#deleted).\n\
        * The payment source must not be the current primary payment source of the\
        \ customer.\n* This operation doesn't validate the `status` of the payment\
        \ source. Check the `status` of the payment source before you assign it to\
        \ the primary or backup role.  \n\n### Impacts\n\n**#### Payment collection**\
        \  \nThe roles that you set using this API apply to all payments collected\
        \ for the customer, except for subscriptions that have a payment source attached\
        \ to them. Chargebee continues to collect such payments using the payment\
        \ source attached to the subscription.  \n**#### Customer**  \n* When you\
        \ assign a payment source as primary, Chargebee unassigns the existing primary\
        \ payment source and doesn't affect the backup payment source.\n* When you\
        \ assign a payment source as backup, Chargebee unassigns the existing backup\
        \ payment source and doesn't affect the primary payment source.\n* You can\
        \ set the role of a `backup` payment source to `primary` or `none`.\n* You\
        \ cannot set the role of a `primary` payment source to either `backup` or\
        \ `none`.  \n\n### Implementation Notes\n\nBefore you call this API, ensure\
        \ the following:\n\n* The [`payment_source.customer_id`](/docs/api/payment_sources/payment_source-object#customer_id)\
        \ matches the `id` of the customer.\n* The `payment_source_id` isn't the same\
        \ as the [`customer.primary_payment_source_id`](/docs/api/customers/customer-object#primary_payment_source_id).\n\
        * Since this API doesn't validate the [`status`](/docs/api/payment_sources/payment_source-object#status)\
        \ of the payment source, check the `payment_source.status` to ensure it isn't\
        \ `expired`, `invalid`, or `pending_verification`.\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing customer
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: |
                      Resource object representing payment_source
                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:
      tags:
      - customers
      summary: Move a customer
      description: "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 `{site}`; whereas, the source site (the site from\
        \ which the customer is copied) is specified by the query parameter `from_site`.\
        \  \n**Prerequisites**\n\n* This endpoint is disabled by default. For the\
        \ operation to work, the endpoint must be enabled for both the source and\
        \ destination sites. 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)\
        \ to have it enabled.\n* The customer's `preferred_currency_code` must be\
        \ enabled in the destination site.\n"
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing resource_migration
                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:
      tags:
      - customers
      summary: Get account hierarchy for a customer
      description: |
        Retrieves the full or partial [account hierarchy](/docs/api/hierarchies)
        for a customer.
      operationId: get_hierarchy
      parameters:
      - name: hierarchy_operation_type
        in: query
        description: |
          Specifies which part of the account hierarchy to retrieve for the customer identified by `{customer_id}`
          .

          * complete_hierarchy - Retrieve all nodes in the account hierarchy.
          * subordinates -
            Retrieve all nodes in the account hierarchy that start from the specified customer (identified by `{customer_id}`
            ) and include its subordinates. In other words, get nodes in the account hierarchy tree where the root node is the specified customer.
          * path_to_root -
            Retrieve nodes from the specified customer (identified by `{customer_id}`
            ) to the root of its account hierarchy.
        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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
                  hierarchies:
                    type: array
                    description: |
                      Resource object representing hierarchy
                    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:
      tags:
      - customers
      summary: Update payment method for a customer
      description: "[Payment Sources](/docs/api/payment_sources)\ncomes with additional\
        \ options and improvements to the [Card APIs](/docs/api/cards)\n. For this\
        \ operation, use the [Create using temporary token](/docs/api/payment_sources/create-using-gateway-temporary-token)\n\
        API or [Create using permanent token](/docs/api/payment_sources/create-using-permanent-token)\n\
        API under Payment Sources to update payment method for the customer.\n\nUpdates\
        \ payment method details for a customer.  \n**Note:**\nIf you wish to pass\
        \ the card number, CVV, or the single-use card tokens provided by gateways\
        \ like Stripe, then use the [Update card for a customer](/docs/api/cards/update-card-for-a-customer)\n\
        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.\n\
        \n**PayPal Express Checkout**\n\nYou can use this API if you are directly\
        \ integrating PayPal Express Checkout in your website instead of using Chargebee's\
        \ hosted pages. When your customer updates his payment method using PayPal\
        \ Express Checkout, you will be provided with the *Billing Agreement ID* by\
        \ PayPal. You can update the payment method for that customer in Chargebee\
        \ by passing `type` as `paypal_express_checkout` and `reference_id` with the\
        \ *Billing Agreement ID*.\n\n**Login and Pay with Amazon**\n\nYou can use\
        \ this API if you are directly integrating *Login and Pay with Amazon* in\
        \ your website instead of using Chargebee's hosted pages. When your customer\
        \ updates Amazon as a payment method, you will be provided with the *Billing\
        \ Agreement ID* by Amazon. You can update the payment method for that customer\
        \ in Chargebee by passing `type` as `amazon_payments` and `reference_id` with\
        \ the *Billing Agreement ID*.\n\n**Card Payments**\n\nWhen 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 *reference id* provided by them in Chargebee.\
        \ To use this API, pass\n\n* `type` as `card`.\n* `gateway` with the gateway\
        \ associated with the card. If the gateway is not specified, the default gateway\
        \ will be used.\n* `reference_id` with the identifier provided by the gateway/Spreedly\
        \ to reference that specific card.\n\n**Reference id format for Card Payments**\n\
        \nThe format of reference_id will differ based on where the card is stored.\n\
        \n**Stripe:** In case of Stripe, the reference_id consists of combination\
        \ of Stripe Customer ID and Stripe Card ID separated by forward slash (e.g.\
        \ *cus_63MnDn0t6kfDW7/card_6WjCF20vT9WN1G*). If you are passing Stripe Customer\
        \ ID alone, then Chargebee will store the card marked as active for that customer\
        \ in Stripe.\n\n**Braintree:** In case of Braintree, the reference_id consists\
        \ of combination of Braintree Customer ID and Braintree Payment Method Token\
        \ separated by forward slash\n\n(e.g. *cus_63MnDn0t6kfDW7/card_6WjCF20vT9WN1G*\
        \ ). If you are passing Braintree Customer ID alone, then Chargebee will store\
        \ the card marked as default for that customer in Braintree.\n\n**Spreedly\
        \ Card vault:** If the card details are stored in Spreedly vault, then you\
        \ need to provide the Spreedly token as `reference_id`.\n\n**Direct Debit\
        \ Payments**\n\nWhen 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\n\n* `type` as `direct_debit`.\n\
        * `gateway` with the gateway where the bank account details are stored (e.g.\
        \ *authorize_net*). If the gateway is not specified, the gateway supporting\
        \ the direct debit will be used.\n* `reference_id` with the identifier provided\
        \ by the gateway to reference the customer's bank account details.\n* `tmp_token`\
        \ with the single use token provided by the gateway ( Should be passed only\
        \ if reference_id is not passed ).\n\n**Reference id format for Direct Debit\
        \ Payments**\n\nThe format of reference_id will differ based on where the\
        \ bank account is stored.\n\n**Stripe:** In case of Stripe, the reference_id\
        \ consists of combination of Stripe Customer ID and Stripe Bank Account ID\
        \ separated by forward slash\n\n(e.g. *cus_8suoHaLQH4G5AW/ba_18b8z2KmcbENlhgU03RznRYW*).\
        \ 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.\n\n**Authorize.Net:** The reference_id consists of combination\
        \ of Authorize.Net's Customer Profile ID and Payment Profile ID separated\
        \ by forward slash (e.g. *2384383/34834382*). If you are passing Authorize.Net'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.\n\
        \n**GoCardless:** The reference_id is the GoCardless Customer Mandate ID (e.g.\
        \ *MD0077Z99TTQXK*).\n\n**Note:** While using this API to update payment method\
        \ details, [Card Verification](https://www.chargebee.com/docs/cards.html#card-verification)\
        \ will not happen even if it is enabled for that particular gateway.\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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\n* grab_pay - Payments made\
                        \ via GrabPay\n* sepa_instant_transfer - Payments made via\
                        \ Sepa Instant Transfer\n* touch_n_go - Payments made via\
                        \ Touch 'n Go.\n* direct_debit - Represents bank account for\
                        \ which the direct debit or ACH agreement/mandate is created.\n\
                        * rakuten_pay - Payments made via Rakuten Pay.\n* ovo - Payments\
                        \ made via OVO.\n* momo - Payments made via MoMo.\n* mercado_pago\
                        \ - Payments made via Mercado Pago.\n* paypay - Payments made\
                        \ via PayPay\n* south_korean_cards - Payments made via South\
                        \ Korean Cards\n* blik - Payments made via BLIK.\n* go_pay\
                        \ - Payments made via GoPay\n* dana - Payments made via Dana.\n\
                        * bancontact - Payments made via Bancontact Card.\n* dotpay\
                        \ - Payments made via Dotpay.\n* p24 - Payments made via Przelewy24\
                        \ (P24).\n* automated_bank_transfer - Represents virtual bank\
                        \ account using which the payment will be done.\n* nequi -\
                        \ Payments made via Nequi.\n* upi - UPI Payments.\n* google_pay\
                        \ - Payments made via Google Pay.\n* revolut_pay - Payments\
                        \ made via Revolut Pay.\n* amazon_payments - Payments made\
                        \ via Amazon Payments.\n* klarna - Payments made via Klarna.\n\
                        * gcash - Payments made via GCash.\n* paypal_express_checkout\
                        \ - Payments made via PayPal Express Checkout.\n* after_pay\
                        \ - Payments made via Afterpay\n* qpay - Payments made via\
                        \ Qpay.\n* card - Card based payment including credit cards\
                        \ and debit cards. Details about the card can be obtained\
                        \ from the card resource.\n* ideal - Payments made via iDEAL.\n\
                        * pix - Payments made via Pix\n* pay_by_bank - Pay By Bank\n\
                        * stablecoin - Payments made via Stablecoin.\n* sofort - Payments\
                        \ made via Sofort.\n* alipay -\n  Payments made via Alipay.\
                        \  \n  This payment source is deprecated.\n* twint - Payments\
                        \ made via Twint\n* affirm_pay - Payments made via Affirm\
                        \ Pay.\n* electronic_payment_standard - Electronic Payment\
                        \ Standard\n* generic - Payments made via Generic Payment\
                        \ Method.\n* tamara - Payments made via Tamara.\n* klarna_pay_now\
                        \ - Payments made via Klarna Pay Now\n* netbanking_emandates\
                        \ - Netbanking (eMandates) Payments.\n* payme - Payments made\
                        \ via PayMe\n* online_banking_poland - Payments made via Online\
                        \ Banking Poland\n* pay_to - Payments made via PayTo\n* unionpay\
                        \ - Payments made via UnionPay.\n* faster_payments - Payments\
                        \ made via Faster Payments\n* nupay - Payments made via NuPay.\n\
                        * pay_co - Payments made via PayCo\n* thai_qr - Payments made\
                        \ via Thai QR.\n* swish - Payments made via Swish\n* picpay\
                        \ - Payments made via PicPay.\n* trustly - Trustly\n* venmo\
                        \ - Payments made via Venmo\n* kbc_payment_button - KBC Payment\
                        \ Button\n* giropay - Payments made via giropay.\n* kakao_pay\
                        \ - Payments made via Kakao Pay.\n* alipay_hk - Payments made\
                        \ via Alipay HK.\n* fpx - Payments made via FPX.\n* wechat_pay\
                        \ -\n  Payments made via WeChat Pay.  \n  This payment source\
                        \ is deprecated.\n* payconiq_by_bancontact - Payments made\
                        \ via Payconiq by Bancontact.\n* naver_pay - Payments made\
                        \ via Naver Pay.\n* wero - Payments made via Wero.\n* cash_app_pay\
                        \ - Payments 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
                      - alipay_hk
                      - paypay
                      - gcash
                      - south_korean_cards
                      - paynow
                      - bizum
                      - promptpay
                      - dana
                      - touch_n_go
                      - tamara
                      - qpay
                      - ovo
                      - momo
                      - mercado_pago
                      - nequi
                      - nupay
                      - picpay
                      - thai_qr
                      - blik
                      - fpx
                      - wero
                      - p24
                      - affirm_pay
                      - rakuten_pay
                      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: |
                        [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)
                        .

                        **Note**:
                        If you enter an invalid country code, the system will return an error.

                        If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)
                        in 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)
                        the Brexit configuration, then `XI`
                        (the code for **United Kingdom - Northern Ireland**
                        ) is available as an option.
                      maxLength: 50
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |
                        * `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal).

                          * `payer`: User related information.
                            * `country_of_residence`: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a [two-character ISO code](https://docs.checkout.com/resources/codes/country-codes).
                            * `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
                        * `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
                        * `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user's `device_session_id` can be added to perform [additional validation](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                            * `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
                        * `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
                        * `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                        * `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.

                          * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
                        * `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.

                          * `payer`: User related information.
                            * `document`: Document is the user's identification number based on their country.
                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device
                      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: |
                      Resource object representing customer
                  card:
                    $ref: "#/components/schemas/Card"
                    description: |
                      Resource object representing card
                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:
      tags:
      - customers
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing customer
                  card:
                    $ref: "#/components/schemas/Card"
                    description: |
                      Resource object representing card
                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:
      tags:
      - customers
      summary: Update a customer
      description: "Updates the details of the specified [customer](/docs/api/customers).\n\
        \nUse this API to modify customer information, including standard attributes\
        \ and any configured [custom attributes](/docs/api/advanced-features).\n\n\
        * To update the billing address or VAT number, use the [Update billing info\
        \ for a customer](/docs/api/customers/update-billing-info-for-a-customer)\
        \ API instead.\n* The Account Hierarchy (Parent-Child Relationship) cannot\
        \ be updated using this API.\n  * To add a child to a Parent Account, use\
        \ the [Link a customer to an account](/docs/api/customers/link-a-customer)\
        \ API.\n* To remove a child from a Parent Account, use the [Unlink a customer\
        \ from its parent account](/docs/api/customers/delink-a-customer) API.  \n\
        \n### Impacts\n\n**Invoices**  \n* See [`auto_collection`](/docs/api/customers/update-a-customer#auto_collection)\
        \ parameter to understand the impact on invoices.\n* See [`taxability`](/docs/api/customers/update-a-customer#taxability)\
        \ parameter to understand how taxes on invoices are impacted.  \n**CRM integrations**\
        \  \nWhen you update customer details in Chargebee using this API, the corresponding\
        \ records are synced with integrated CRM systems, such as [HubSpot](https://www.chargebee.com/docs/billing/2.0/integrations/hubspot)\
        \ or [Salesforce](https://www.chargebee.com/docs/billing/2.0/integrations/chargebee-salesforce),\
        \ depending on your integration configuration.  \n\n#### Related APIs\n\n\
        [Update billing info for a customer](/docs/api/customers?prod_cat_ver=2#update_billing_info_for_a_customer)[Link\
        \ a customer to an account](/docs/api/customers?prod_cat_ver=2#link_a_customer)[Unlink\
        \ a customer from its parent account](/docs/api/customers?prod_cat_ver=2#delink_a_customer)\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: "Determines whether payments should be collected automatically\
                    \ for this customer.  \n**Note**\nThis setting can be overridden\
                    \ at the [subscription level](/docs/api/subscriptions/update-subscription-for-items#auto_collection).\n\
                    \n* on - Payments are automatically collected for new invoices.\
                    \ For existing invoices, Chargebee attempts collections through\
                    \ [dunning](https://www.chargebee.com/docs/payments/2.0/dunning/dunning-v2)\
                    \ as per the configured schedule.\n* off - Payments are not automatically\
                    \ collected for this customer.\n"
                  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 from [`invoice.date`](/docs/api/invoices/invoice-object#date) until payment for the invoice is due.
                  example: null
                taxability:
                  type: string
                  default: taxable
                  deprecated: false
                  description: |
                    Specifies whether taxes are applicable to invoices generated for this customer.

                    * taxable -
                      Taxes are calculated for this customer based on the [site's tax configuration](https://www.chargebee.com/docs/tax.html).
                      In some regions, [shipping_address](/docs/api/customers) is required for tax computation.
                      If a shipping address is not provided, the [billing_address](/docs/api/customers) is used. If neither address is available, no tax is applied.
                    * zero_rated - This option is available only when zero-rated customer taxability is enabled for the site and the site uses [Chargebee Taxes](https://www.chargebee.com/docs/tax.html); third-party tax providers and integrations are not supported. Otherwise taxable line items for the customer are taxed at 0%. These line items have `is_taxed` set to `true`, the tax rate and tax amount set to `0`, and `tax_exempt_reason` set to `zero_rated`. Unlike `exempt`, this option follows the taxable tax path at a zero rate.
                    * exempt -
                      The customer is exempt from tax.

                      * If you use Chargebee [Taxes](https://www.chargebee.com/docs/tax.html) or the [TaxJar integration](https://www.chargebee.com/docs/taxjar.html), no additional action is required.
                      * If you use the [Avalara integration](https://www.chargebee.com/docs/avalara.html), optionally specify the `entity_code` or `exempt_number` attributes with [AvaTax for Sales](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption), or the `exemption_details` attribute with [AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html). Avalara may still apply tax depending on the values of `entity_code`, `exempt_number`, or `exemption_details`, and the jurisdiction (state, region, or province) of the taxable address.
                  enum:
                  - taxable
                  - exempt
                  - zero_rated
                  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/billing/2.0/usage-based-billing/metered_billing#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.  \n**Note:**\nThere's a character\
                    \ limit of 65,535.\n\n[Learn more](/docs/api/advanced-features)\n\
                    .\n"
                  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
                    * safe - The customer has been marked as safe
                  enum:
                  - safe
                  - fraudulent
                  example: null
                consolidated_invoicing:
                  type: boolean
                  deprecated: false
                  description: "Indicates whether invoices raised on the same day\
                    \ for the `customer` are consolidated. When provided, this overrides\
                    \ the default configuration at the [site-level](https://www.chargebee.com/docs/consolidated-invoicing.html#configuring-consolidated-invoicing).\
                    \ This parameter can be provided only when [Consolidated Invoicing](https://www.chargebee.com/docs/consolidated-invoicing.html)\
                    \ is enabled.  \n**Note:**\n\nAny invoices raised when a subscription\
                    \ activates from `in_trial` or `future` `status`, are not consolidated\
                    \ by default. [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 enable consolidation for such invoices.\n\n.\n"
                  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: |
                      Resource object representing customer
                  card:
                    $ref: "#/components/schemas/Card"
                    description: |
                      Resource object representing card
                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:
      tags:
      - customers
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |
          Used for pagination. Set this to the `next_offset`
          value from the previous API response to fetch the next page.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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.
          * path_to_root - Fetches a list of nodes along the path from the customer to the root of the hierarchy.
        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:
      tags:
      - customers
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: "`billing_month`, together with `billing_date`, specify,\
                    \ for this customer, the day of the year when the renewals of\
                    \ all the year-based subscriptions take place.\n\nFor example,\
                    \ the renewals happen on 15th July when `billing_month` is `7`\
                    \ and `billing_date` is `15`.  \n**Note**\nApplicable when [Calendar\
                    \ Billing](https://www.chargebee.com/docs/calendar-billing.html)\
                    \ (with customer-specific billing date support) is enabled and\
                    \ `billing_date_mode` is `manually_set`.\n"
                  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: |
                      Resource object representing customer
                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:
      tags:
      - customers
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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\] = "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_not\] = "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_not\] = "(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, zero_rated.

          **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 [site configuration](https://www.chargebee.com/docs/tax.html). 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` -
                  * Customer is exempted from tax. When using Chargebee's native [Taxes](https://www.chargebee.com/docs/tax.html) feature or when using the [TaxJar integration](https://www.chargebee.com/docs/taxjar.html), no other action is needed.
                  * However, when using our [Avalara integration](https://www.chargebee.com/docs/avalara.html), optionally, specify `entity_code` or `exempt_number` attributes if you use Chargebee's [AvaTax for Sales](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption) or specify `exemption_details` attribute if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. Tax may still be applied by Avalara for certain values of `entity_code`/`exempt_number`/`exemption_details` based on the state/region/province of the taxable address.
                * `zero_rated` - With [Chargebee Taxes](https://www.chargebee.com/docs/tax.html), otherwise taxable line items for the customer are taxed at 0%. These line items have `is_taxed` set to `true`, the tax rate and tax amount set to `0`, and `tax_exempt_reason` set to `zero_rated`. Unlike `exempt`, this option follows the taxable tax path at a zero rate.
              enum:
              - taxable
              - exempt
              - zero_rated
              example: null
            is_not:
              type: string
              description: |
                * `taxable` - Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html). 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` -
                  * Customer is exempted from tax. When using Chargebee's native [Taxes](https://www.chargebee.com/docs/tax.html) feature or when using the [TaxJar integration](https://www.chargebee.com/docs/taxjar.html), no other action is needed.
                  * However, when using our [Avalara integration](https://www.chargebee.com/docs/avalara.html), optionally, specify `entity_code` or `exempt_number` attributes if you use Chargebee's [AvaTax for Sales](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption) or specify `exemption_details` attribute if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. Tax may still be applied by Avalara for certain values of `entity_code`/`exempt_number`/`exemption_details` based on the state/region/province of the taxable address.
                * `zero_rated` - With [Chargebee Taxes](https://www.chargebee.com/docs/tax.html), otherwise taxable line items for the customer are taxed at 0%. These line items have `is_taxed` set to `true`, the tax rate and tax amount set to `0`, and `tax_exempt_reason` set to `zero_rated`. Unlike `exempt`, this option follows the taxable tax path at a zero rate.
              enum:
              - taxable
              - exempt
              - zero_rated
              example: null
            in:
              type: string
              description: |
                * `taxable` - Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html). 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` -
                  * Customer is exempted from tax. When using Chargebee's native [Taxes](https://www.chargebee.com/docs/tax.html) feature or when using the [TaxJar integration](https://www.chargebee.com/docs/taxjar.html), no other action is needed.
                  * However, when using our [Avalara integration](https://www.chargebee.com/docs/avalara.html), optionally, specify `entity_code` or `exempt_number` attributes if you use Chargebee's [AvaTax for Sales](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption) or specify `exemption_details` attribute if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. Tax may still be applied by Avalara for certain values of `entity_code`/`exempt_number`/`exemption_details` based on the state/region/province of the taxable address.
                * `zero_rated` - With [Chargebee Taxes](https://www.chargebee.com/docs/tax.html), otherwise taxable line items for the customer are taxed at 0%. These line items have `is_taxed` set to `true`, the tax rate and tax amount set to `0`, and `tax_exempt_reason` set to `zero_rated`. Unlike `exempt`, this option follows the taxable tax path at a zero rate.
              enum:
              - taxable
              - exempt
              - zero_rated
              pattern: "^\\[(taxable|exempt|zero_rated)(,(taxable|exempt|zero_rated))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                * `taxable` - Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html). 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` -
                  * Customer is exempted from tax. When using Chargebee's native [Taxes](https://www.chargebee.com/docs/tax.html) feature or when using the [TaxJar integration](https://www.chargebee.com/docs/taxjar.html), no other action is needed.
                  * However, when using our [Avalara integration](https://www.chargebee.com/docs/avalara.html), optionally, specify `entity_code` or `exempt_number` attributes if you use Chargebee's [AvaTax for Sales](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption) or specify `exemption_details` attribute if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. Tax may still be applied by Avalara for certain values of `entity_code`/`exempt_number`/`exemption_details` based on the state/region/province of the taxable address.
                * `zero_rated` - With [Chargebee Taxes](https://www.chargebee.com/docs/tax.html), otherwise taxable line items for the customer are taxed at 0%. These line items have `is_taxed` set to `true`, the tax rate and tax amount set to `0`, and `tax_exempt_reason` set to `zero_rated`. Unlike `exempt`, this option follows the taxable tax path at a zero rate.
              enum:
              - taxable
              - exempt
              - zero_rated
              pattern: "^\\[(taxable|exempt|zero_rated)(,(taxable|exempt|zero_rated))*\\\
                ]$"
              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\[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`.
          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 `sort_by`
          input parameter as `updated_at`
          for a faster response.
          **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: 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/billing/2.0/usage-based-billing/metered_billing#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.\n* `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.\n* `play_store` -\n  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.  \n  In-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.\n* `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.\n* `play_store` -\n  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.  \n  In-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.\n* `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.\n* `play_store` -\n  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.  \n  In-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.\n* `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.\n* `play_store` -\n  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.  \n  In-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

          The unique ID of the [business entity](/docs/api/advanced-features)
          of this subscription. This is always the same as the
          [business entity](/docs/api/subscriptions/subscription-object#customer_id)
          of the customer.

          **Supported operators :**
          is, is_not, starts_with

          **Example →**
          *business_entity_id\[is_not\] = "business_entity_id"*
        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:
      tags:
      - customers
      summary: Create a customer
      description: "Creates a customer resource. Optionally, creates a payment source\
        \ for the customer.  \n**Creating payment source**\n\nAlthough this operation\
        \ supports creation of a customer with a [payment source](/docs/api/payment_sources),\
        \ it is recommended to use one of the [Payment Source APIs](/docs/api/payment_sources)\
        \ to capture payment source details instead of using this operation. This\
        \ way, even if payment source creation fails due to errors at the payment\
        \ gateway, the customer resource can still be created successfully.  \n\n\
        ### Impacts\n\n**#### Customer**  \n* If the multi-business entity feature\
        \ is enabled, the customer is linked to the business entity specified; otherwise,\
        \ the customer record is linked to the [default business entity](/docs/api/advanced-features)\
        \ defined for the site.  \n**#### Invoices**  \n* Chargebee uses the `billing_address`\
        \ object from the customer to set the values in the [`billing_address`](/docs/api/invoices/invoice-object#billing_address)\
        \ of the invoices generated for the customer.\n* If the `billing_address`\
        \ object does not include the `first_name`, `last_name`, or `company` fields,\
        \ Chargebee automatically uses the values from [`customer.first_name`](/docs/api/customers/customer-object#first_name),\
        \ [`customer.last_name`](/docs/api/customers/customer-object#last_name), and\
        \ [`customer.company`](/docs/api/customers/customer-object#company) (if available)\
        \ when generating invoices.  \n**#### Payment source**  \n* If `payment_intent`\
        \ or `payment_method` parameter is passed, a `payment_source` resource of\
        \ the appropriate type is created for the customer.\n* If `bank_account` parameter\
        \ is passed, a `payment_source` resource of `type` `direct_debit` is created\
        \ for the customer.\n* If `card` parameter is passed, a `payment_source` resource\
        \ of `type` `card` is created for the customer.  \n**##### Integrations**\
        \  \n* If CRM systems are connected to Chargebee, a corresponding record is\
        \ created in the connected CRM (such as Salesforce, and HubSpot).  \n\n###\
        \ Use Cases\n\n#### Create payment source using `payment_intent`\n\nUse the\
        \ `payment_intent` parameter to create a payment source for the customer.\
        \ Using payment intents is the recommended way to create a payment source\
        \ in Chargebee for both [Strong Customer Authentication](https://www.chargebee.com/docs/payments/2.0/others/psd2-sca)\
        \ (SCA) (i.e. 3D-Secure) and non-SCA flows.\n\n1. Create a `payment_intent`\
        \ resource by calling the [Create a payment intent API](/docs/api/payment_intents/create-a-payment-intent).\n\
        2. Pass the `payment_intent` object to your frontend and use Chargebee.js\
        \ to capture the payment source details from the customer. Use [Payment Components](https://www.chargebee.com/docs/payments/2.0/payment-components/overview)\
        \ to show payment method UIs and collect payment method details from the customer.\n\
        3. Listen to the [`payment_intent_updated`](/docs/api/events#payment_intent_updated)\
        \ event. Once the `payment_intent.status` is `authorized`, pass the `payment_intent.id`\
        \ using the `payment_intent[id]` parameter in this API call.  \n\n#### Create\
        \ payment source using `payment_method`\n\nIf you prefer to use the payment\
        \ gateway's SDKs to capture the payment method details, you can then use the\
        \ `payment_method` parameter in this API to pass the payment method token\
        \ and other details.\n\n1. Use the JavaScript library of your payment gateway\
        \ to capture the payment method details. Examples include:\n\n* [Stripe.js](https://stripe.com/docs/js)\n\
        * [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2)\n\
        * [Accept.js](https://developer.authorize.net/api/reference/features/acceptjs.html)\
        \ (if you use [Authorize.Net](https://developer.authorize.net/api/reference/features/acceptjs.html))\n\
        * Adyen's [Client-Side Encryption](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/cse-integration-ecommerce)\
        \ (if you use Adyen)\n\n1. Pass the payment method token using the `payment_method[reference_id]`\
        \ or `payment_method[tmp_token]` parameter along with any additional parameters\
        \ required by the payment gateway to create the payment source.  \n\n####\
        \ Create payment source using `bank_account`\n\nYou can pass raw bank account\
        \ details via this API. Use the `bank_account` parameter to pass the bank\
        \ account details.  \n\n#### Create payment source using `card`\n\nIf you\
        \ are PCI compliant, you can pass raw card details via this API. Use the `card`\
        \ parameter to pass the card details.  \n\n#### Related APIs\n\n[Update a\
        \ customer](/docs/api/customers?prod_cat_ver=2#update_a_customer)[Update billing\
        \ info for a customer](/docs/api/customers?prod_cat_ver=2#update_billing_info_for_a_customer)\n"
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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 address of the customer. Configured email notifications are sent to this email address. Invalid email address will result in an error.
                  maxLength: 70
                  example: null
                preferred_currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The currency code (in [ISO 4217 format](https://www.iso.org/iso-4217-currency-codes.html)) of the customer.
                  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 from [`invoice.date`](/docs/api/invoices/invoice-object#date) until payment for the invoice is due.
                  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: |
                    The VAT/tax registration number for the customer. For customers with [billing_address](/docs/api/customers/customer-object#billing_address)

                    `country`
                    as
                    `XI`
                    (which is **United Kingdom - Northern Ireland**
                    ), the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number)
                    can be overridden by setting
                    [vat_number_prefix](/docs/api/customers/customer-object#vat_number_prefix)
                    .
                  maxLength: 20
                  example: null
                vat_number_prefix:
                  type: string
                  deprecated: false
                  description: |
                    An overridden value for the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number).
                    Only applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)

                    `country`
                    as `XI`
                    (which is **United Kingdom - Northern Ireland**
                    ).

                    When you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)
                    in 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)
                    the Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)

                    `country`
                    as `XI`.
                    That's the code for **United Kingdom - Northern Ireland** .
                    The first two characters of the VAT number in such a case is
                    `XI`
                    by default. However, if the VAT number was registered in UK, the value should be `GB`.
                    Set
                    `vat_number_prefix`
                    to `GB`
                    for such cases.
                  maxLength: 10
                  example: null
                entity_identifier_scheme:
                  type: string
                  deprecated: false
                  description: "The Peppol BIS scheme associated with the [vat_number](/docs/api/customers/customer-object#vat_number)\n\
                    of the customer. This helps identify the specific type of customer\
                    \ entity. For example, `DE:VAT`\nis used for a German business\
                    \ entity while `DE:LWID45`\nis used for a German government entity.\
                    \ The value must be from the list of possible values and must\
                    \ correspond to the country provided under `billing_address.country`.\n\
                    See [list of possible values](https://www.chargebee.com/docs/e-invoicing.html#supported-countries)\n\
                    .  \n**Tip:**\n\nIf there are additional entity identifiers for\
                    \ the customer not associated with the `vat_number`, they can\
                    \ be provided as the `entity_identifiers[]` array.\n"
                  maxLength: 50
                  example: null
                entity_identifier_standard:
                  type: string
                  default: iso6523-actorid-upis
                  deprecated: false
                  description: "The standard used for specifying the `entity_identifier_scheme`.\n\
                    Currently only `iso6523-actorid-upis`\nis supported and is used\
                    \ by default when not provided.  \n**Tip:**\n\nIf there are additional\
                    \ entity identifiers for the customer not associated with the\
                    \ `vat_number`, they can be provided as the `entity_identifiers[]`\
                    \ array.\n"
                  maxLength: 50
                  example: null
                registered_for_gst:
                  type: boolean
                  deprecated: false
                  description: |
                    Confirms that a customer is registered under GST. If set to `true`
                    then the [Reverse Charge Mechanism](https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism)
                    is applicable. This field is applicable only when Australian GST is configured for your site.
                  example: null
                is_einvoice_enabled:
                  type: boolean
                  deprecated: false
                  description: "Determines whether the customer is e-invoiced. When\
                    \ set to `true`\nor not set to any value, the customer is e-invoiced\
                    \ so long as e-invoicing is enabled for their country (`billing_address.country`\n\
                    ). When set to `false`\n, the customer is not e-invoiced even\
                    \ if e-invoicing is enabled for their country.  \n**Tip:**\n\n\
                    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.\n"
                  example: null
                einvoicing_method:
                  type: string
                  deprecated: false
                  description: |
                    Determines whether to send an e-invoice 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: |
                    Specifies if the customer is liable for tax.

                    * zero_rated - This option is available only when zero-rated customer taxability is enabled for the site and the site uses [Chargebee Taxes](https://www.chargebee.com/docs/tax.html). Third-party tax providers and integrations are not supported. Line items that would otherwise be taxable are taxed at 0%. For these line items, `is_taxed` is `true`, the tax rate and tax amount are `0`, and `tax_exempt_reason` is `zero_rated`. Unlike `exempt`, `zero_rated` follows the taxable tax path at a zero rate.
                    * taxable -
                      Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html).
                      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 -
                      * Customer is exempted from tax. When using Chargebee's native [Taxes](https://www.chargebee.com/docs/tax.html) feature or when using the [TaxJar integration](https://www.chargebee.com/docs/taxjar.html), no other action is needed.
                      * However, when using our [Avalara integration](https://www.chargebee.com/docs/avalara.html), optionally, specify `entity_code` or `exempt_number` attributes if you use Chargebee's [AvaTax for Sales](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption) or specify `exemption_details` attribute if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. Tax may still be applied by Avalara for certain values of `entity_code`/`exempt_number`/`exemption_details` based on the state/region/province of the taxable address.
                  enum:
                  - taxable
                  - exempt
                  - zero_rated
                  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. Use the [language pack](https://www.chargebee.com/docs/billing/2.0/customers/configure-multiple-languages#step-2-download-the-language-pack-and-provide-the-translations)\
                    \ to customize the translations for each locale.  \n**Default\
                    \ behavior**\n\n* If you don't pass `locale`, or if you pass it\
                    \ but it is not added and activated in Chargebee, then the [primary\
                    \ language](https://www.chargebee.com/docs/billing/2.0/customers/configure-multiple-languages#primary-language-of-your-chargebee-site)\
                    \ for customers would be used.\n"
                  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.  \n**Note:**\nThere's a character\
                    \ limit of 65,535.\n\n[Learn more](/docs/api/advanced-features)\n\
                    .\n"
                  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/billing/2.0/usage-based-billing/metered_billing#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: "Indicates whether invoices raised on the same day\
                    \ for the `customer` are consolidated. When provided, this overrides\
                    \ the default configuration at the [site-level](https://www.chargebee.com/docs/consolidated-invoicing.html#configuring-consolidated-invoicing).\
                    \ This parameter can be provided only when [Consolidated Invoicing](https://www.chargebee.com/docs/consolidated-invoicing.html)\
                    \ is enabled.  \n**Note:**\n\nAny invoices raised when a subscription\
                    \ activates from `in_trial` or `future` `status`, are not consolidated\
                    \ by default. [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 enable consolidation for such invoices.\n\n.\n"
                  example: null
                token_id:
                  type: string
                  deprecated: false
                  description: "The Chargebee payment token generated by [Chargebee.js](https://www.chargebee.com/docs/payments/2.0/card-components-and-helpers/3ds-helper#using-the-gateways-hosted-fields).\
                    \  \n**Note** :\nThe payment token created via Chargebee.js uses\
                    \ the gateway selected through [Smart Routing](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/gateway_settings#smart-routing).\n\
                    Explicitly passing a `gateway_id`\nin this API call will not override\
                    \ the gateway associated with the token.\n"
                  maxLength: 40
                  example: null
                business_entity_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [business entity](/docs/api/advanced-features)\
                    \ this customer should be [linked](/docs/api/advanced-features)\
                    \ to. An alternative way of passing this parameter is by means\
                    \ of a [custom HTTP header](/docs/api/advanced-features).  \n\
                    **Default behavior**\n\n* When not provided, the customer is linked\
                    \ to the [default business entity](/docs/api/advanced-features)\
                    \ defined for the site.\n"
                  maxLength: 50
                  example: null
                brand_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [brand](/docs/api/brands) this\
                    \ customer should be linked to. Applicable only when multiple\
                    \ brands have been created for the site. An alternative way of\
                    \ passing this parameter is by means of the `chargebee-brand-id`\
                    \ custom HTTP header; when both are provided, they must specify\
                    \ the same brand.  \n**Default behavior**\n\n* When not provided,\
                    \ the customer is linked to the default brand defined for the\
                    \ site.\n"
                  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
                card:
                  type: object
                  deprecated: false
                  description: "Parameters for card. Use this parameter to pass raw\
                    \ card details.  \nPassing raw card data via API involves PCI\
                    \ liability at your end due to the sensitivity of the data.\n"
                  properties:
                    gateway_account_id:
                      type: string
                      deprecated: false
                      description: "The gateway account in which these card details\
                        \ are stored.  \n**Required when**\n\n* All of the following\
                        \ conditions are met together:\n* Passing `card` parameter.\n\
                        * There are multiple [payment gateway](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/gateway_settings)\
                        \ accounts configured for the site.\n* [Smart Routing](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/gateway_settings#smart-routing)\
                        \ is not configured for card payments.\n"
                      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 16 digit credit card number.  \nIf 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.\n"
                      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 supported\
                        \ only for Stripe, Adyen, and Chargebee Payments.\n\n* cartes_bancaires\
                        \ - A Cartes Bancaires card scheme.\n* mastercard - A MasterCard\
                        \ scheme.\n* dankort - A Dankort card scheme. Supported only\
                        \ for Adyen and Chargebee Payments.\n* visa - A Visa card\
                        \ scheme.\n"
                      enum:
                      - cartes_bancaires
                      - mastercard
                      - visa
                      - dankort
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `billing_state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    billing_state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `billing_state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      maxLength: 50
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |
                        * `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal).

                          * `payer`: User related information.
                            * `country_of_residence`: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a [two-character ISO code](https://docs.checkout.com/resources/codes/country-codes).
                            * `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
                        * `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
                        * `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user's `device_session_id` can be added to perform [additional validation](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                            * `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
                        * `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
                        * `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                        * `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.

                          * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
                        * `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.

                          * `payer`: User related information.
                            * `document`: Document is the user's identification number based on their country.
                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device
                      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.  \n**Required when**\n\n* All of the following\
                        \ conditions are met together:\n* Passing `bank_account` parameter.\n\
                        * There are multiple [payment gateway](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/gateway_settings)\
                        \ accounts configured for the site.\n* [Smart Routing](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/gateway_settings#smart-routing)\
                        \ is not configured for bank account payments.\n"
                      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: |
                        The billing address associated with the bank account. The value is a JSON object with the following keys and their values:- `first_name`:(string, max chars=150) The first name of the contact.

                        * `last_name`:(string, max chars=150) The last name of the contact.
                        * `company_name`:(string, max chars=250) The company name for the address.
                        * `line1`:(string, max chars=180) The first line of the address.
                        * `line2`:(string, max chars=180) The second line of the address.
                        * `country`:(string) The name of the country for the address.
                        * `country_code`:(string, max chars=50) The two-letter, [ISO 3166 alpha-2](https://www.iso.org/iso-3166-country-codes.html) country code for the address.
                        * `state`:(string, max chars=50) The name of the state or province for the address. When not provided, this is set automatically for US, Canada, India, and UAE.
                        * `state_code`:(string, max chars=50) The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code/) without the country prefix. This is supported for USA, Canada, India, and UAE. For instance, for Arizona (USA), set state_code as `AZ` (not `US-AZ`). For Tamil Nadu (India), set as `TN` (not `IN-TN`). For British Columbia (Canada), set as `BC` (not `CA-BC`). For Dubai (UAE), set as `DU` (not `AE-DU`).
                        * `city`:(string, max chars=50) The city name for the address.
                        * `postal_code`:(string, max chars=20) The postal or ZIP code for the address.
                        * `phone`:(string, max chars=50) The contact phone number for the address.
                        * `email`:(string, max chars=70) The contact email address for the address.
                      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\n* grab_pay - Payments made\
                        \ via GrabPay\n* go_pay - Payments made via GoPay\n* nequi\
                        \ - Payments made via Nequi.\n* google_pay - Payments made\
                        \ via Google Pay.\n* after_pay - Payments made via Afterpay\n\
                        * qpay - Payments made via Qpay.\n* pix - Payments made via\
                        \ Pix\n* pay_by_bank - Pay By Bank\n* sofort - Payments made\
                        \ via Sofort.\n* twint - Payments made via Twint\n* netbanking_emandates\
                        \ - Netbanking (eMandates) Payments.\n* apple_pay - Payments\
                        \ made via Apple Pay.\n* unionpay - Payments made via UnionPay.\n\
                        * giropay - Payments made via giropay.\n* direct_debit - Represents\
                        \ bank account for which the direct debit or ACH agreement/mandate\
                        \ is created.\n* rakuten_pay - Payments made via Rakuten Pay.\n\
                        * ovo - Payments made via OVO.\n* mercado_pago - Payments\
                        \ made via Mercado Pago.\n* paypay - Payments made via PayPay\n\
                        * south_korean_cards - Payments made via South Korean Cards\n\
                        * bancontact - Payments made via Bancontact Card.\n* upi -\
                        \ UPI Payments.\n* revolut_pay - Payments made via Revolut\
                        \ Pay.\n* stablecoin - Payments made via Stablecoin.\n* alipay\
                        \ -\n  Payments made via Alipay.  \n  This payment source\
                        \ is deprecated.\n* tamara - Payments made via Tamara.\n*\
                        \ payme - Payments made via PayMe\n* pay_to - Payments made\
                        \ via PayTo\n* pay_co - Payments made via PayCo\n* picpay\
                        \ - Payments made via PicPay.\n* kakao_pay - Payments made\
                        \ via Kakao Pay.\n* fpx - Payments made via FPX.\n* wechat_pay\
                        \ -\n  Payments made via WeChat Pay.  \n  This payment source\
                        \ is deprecated.\n* sepa_instant_transfer - Payments made\
                        \ via Sepa Instant Transfer\n* dotpay - Payments made via\
                        \ Dotpay.\n* p24 - Payments made via Przelewy24 (P24).\n*\
                        \ klarna - Payments made via Klarna.\n* paypal_express_checkout\
                        \ - Payments made via PayPal Express Checkout.\n* ideal -\
                        \ Payments made via iDEAL.\n* affirm_pay - Payments made via\
                        \ Affirm Pay.\n* electronic_payment_standard - Electronic\
                        \ Payment Standard\n* generic - Payments made via Generic\
                        \ Payment Method.\n* klarna_pay_now - Payments made via Klarna\
                        \ Pay Now\n* faster_payments - Payments made via Faster Payments\n\
                        * thai_qr - Payments made via Thai QR.\n* swish - Payments\
                        \ made via Swish\n* venmo - Payments made via Venmo\n* payconiq_by_bancontact\
                        \ - Payments made via Payconiq by Bancontact.\n* naver_pay\
                        \ - Payments made via Naver Pay.\n* wero - Payments made via\
                        \ Wero.\n* touch_n_go - Payments made via Touch 'n Go.\n*\
                        \ momo - Payments made via MoMo.\n* blik - Payments made via\
                        \ BLIK.\n* dana - Payments made via Dana.\n* automated_bank_transfer\
                        \ - Represents virtual bank account using which the payment\
                        \ will be done.\n* amazon_payments - Payments made via Amazon\
                        \ Payments.\n* gcash - Payments made via GCash.\n* card -\
                        \ Card based payment including credit cards and debit cards.\
                        \ Details about the card can be obtained from the card resource.\n\
                        * online_banking_poland - Payments made via Online Banking\
                        \ Poland\n* nupay - Payments made via NuPay.\n* trustly -\
                        \ Trustly\n* kbc_payment_button - KBC Payment Button\n* alipay_hk\
                        \ - Payments made via Alipay HK.\n* cash_app_pay - Payments\
                        \ 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
                      - alipay_hk
                      - paypay
                      - gcash
                      - south_korean_cards
                      - paynow
                      - bizum
                      - promptpay
                      - dana
                      - touch_n_go
                      - tamara
                      - qpay
                      - ovo
                      - momo
                      - mercado_pago
                      - nequi
                      - nupay
                      - picpay
                      - thai_qr
                      - blik
                      - fpx
                      - wero
                      - p24
                      - affirm_pay
                      - rakuten_pay
                      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: |
                        [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)
                        .

                        **Note**:
                        If you enter an invalid country code, the system will return an error.

                        If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)
                        in 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)
                        the Brexit configuration, then `XI`
                        (the code for **United Kingdom - Northern Ireland**
                        ) is available as an option.
                      maxLength: 50
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |
                        * `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal).

                          * `payer`: User related information.
                            * `country_of_residence`: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a [two-character ISO code](https://docs.checkout.com/resources/codes/country-codes).
                            * `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
                        * `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
                        * `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user's `device_session_id` can be added to perform [additional validation](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                            * `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
                        * `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
                        * `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                        * `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.

                          * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
                        * `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.

                          * `payer`: User related information.
                            * `document`: Document is the user's identification number based on their country.
                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device
                      example: null
                  example: null
                payment_intent:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for payment_intent
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Identifier for the [`payment_intent`](/docs/api/payment_intents) resource. If you provide this parameter, you do not need to pass other `payment_intent` parameters.
                      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 payment method type.  \n**Default value**\n\
                        \n* `card`\n\n* card - card\n* twint - Payments made via Twint\n\
                        * dotpay - dotpay\n* faster_payments - Faster Payments\n*\
                        \ upi - upi\n* kbc_payment_button - KBC Payment Button\n*\
                        \ klarna - Payments made via Klarna.\n* payme - Payments made\
                        \ via PayMe\n* google_pay - google_pay\n* paypal_express_checkout\
                        \ - paypal_express_checkout\n* pix - Pix\n* klarna_pay_now\
                        \ - Klarna Pay Now\n* ideal - ideal\n* picpay - Payments made\
                        \ via PicPay.\n* ovo - Payments made via OVO.\n* boleto -\
                        \ boleto\n* wechat_pay - Payments made via WeChat Pay.\n*\
                        \ after_pay - Payments made via Afterpay\n* grab_pay - Payments\
                        \ made via GrabPay\n* mercado_pago - Payments made via Mercado\
                        \ Pago.\n* direct_debit - direct_debit\n* sepa_instant_transfer\
                        \ - Sepa Instant Transfer\n* bancontact - bancontact\n* touch_n_go\
                        \ - Payments made via Touch 'n Go.\n* qpay - Payments made\
                        \ via Qpay.\n* momo - Payments made via MoMo.\n* affirm_pay\
                        \ - Payments made via Affirm Pay.\n* kakao_pay - Payments\
                        \ made via Kakao Pay.\n* blik - Payments made via BLIK.\n\
                        * dana - Payments made via Dana.\n* south_korean_cards - Payments\
                        \ made via South Korean Cards\n* swish - Payments made via\
                        \ Swish\n* thai_qr - Payments made via Thai QR.\n* go_pay\
                        \ - Payments made via GoPay\n* trustly - Trustly\n* naver_pay\
                        \ - Payments made via Naver Pay.\n* stablecoin - Payments\
                        \ made via Stablecoin.\n* venmo - Venmo\n* alipay - Payments\
                        \ made via Alipay.\n* tamara - Payments made via Tamara.\n\
                        * pay_to - PayTo\n* pay_co - Payments made via PayCo\n* cash_app_pay\
                        \ - Payments made via Cash App Pay.\n* rakuten_pay - Payments\
                        \ made via Rakuten Pay.\n* alipay_hk - Payments made via Alipay\
                        \ HK.\n* netbanking_emandates - netbanking_emandates\n* nequi\
                        \ - Payments made via Nequi.\n* paypay - PayPay\n* payconiq_by_bancontact\
                        \ - Payments made via Payconiq by Bancontact.\n* p24 - Payments\
                        \ made via Przelewy24 (P24).\n* electronic_payment_standard\
                        \ - Electronic Payment Standard\n* wero - Payments made via\
                        \ Wero.\n* pay_by_bank - Pay By Bank\n* apple_pay - apple_pay\n\
                        * online_banking_poland - Online Banking Poland\n* gcash -\
                        \ Payments made via GCash.\n* nupay - Payments made via NuPay.\n\
                        * giropay - giropay\n* sofort - sofort\n* amazon_payments\
                        \ - Amazon Payments\n* fpx - Payments made via FPX.\n* revolut_pay\
                        \ - Payments made via Revolut Pay.\n"
                      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
                      - alipay_hk
                      - paypay
                      - gcash
                      - south_korean_cards
                      - paynow
                      - bizum
                      - promptpay
                      - dana
                      - touch_n_go
                      - tamara
                      - qpay
                      - ovo
                      - momo
                      - mercado_pago
                      - nequi
                      - nupay
                      - picpay
                      - thai_qr
                      - blik
                      - fpx
                      - wero
                      - p24
                      - affirm_pay
                      - rakuten_pay
                      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: |
                        * `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal).

                          * `payer`: User related information.
                            * `country_of_residence`: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a [two-character ISO code](https://docs.checkout.com/resources/codes/country-codes).
                            * `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
                        * `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
                        * `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user's `device_session_id` can be added to perform [additional validation](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                            * `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
                        * `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
                        * `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                        * `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.

                          * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
                        * `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.

                          * `payer`: User related information.
                            * `document`: Document is the user's identification number based on their country.
                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)\n\
                        .  \n**Brexit**\n\nIf you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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: |
                        The unique id for the `entity_identifier`
                        in Chargebee. When not provided, it is autogenerated.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    scheme:
                      type: array
                      description: "The Peppol BIS scheme associated with the [vat_number](/docs/api/customers/customer-object#vat_number)\n\
                        of the customer. This helps identify the specific type of\
                        \ customer entity. For example, `DE:VAT`\nis used for a German\
                        \ business entity while `DE:LWID45`\nis used for a German\
                        \ government entity. The value must be from the list of possible\
                        \ values and must correspond to the country provided under\
                        \ `billing_address.country`.\nSee [list of possible values](https://www.chargebee.com/docs/e-invoicing.html#supported-countries)\n\
                        .  \n**Tip:**\n\nIf there is only one entity identifier for\
                        \ the customer and the value is the same as `vat_number`,\
                        \ then there is no need to provide the `entity_identifiers[]`\
                        \ array. See [description for `entity_identifiers[]`](/docs/api/customers/customer-object#entity_identifiers).\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    value:
                      type: array
                      description: "The value of the `entity_identifier`.\nThis identifies\
                        \ the customer entity on the Peppol network. For example:\
                        \ `10101010-STO-10`\n.  \n**Tip:**\n\nIf there is only one\
                        \ entity identifier for the customer and the value is the\
                        \ same as `vat_number`, then there is no need to provide the\
                        \ `entity_identifiers[]` array. See [description for `entity_identifiers[]`](/docs/api/customers/customer-object#entity_identifiers).\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    standard:
                      type: array
                      description: "The standard used for specifying the `entity_identifier`\n\
                        `scheme`.\nCurrently, only `iso6523-actorid-upis`\nis supported\
                        \ and is used by default when not provided.  \n**Tip:**\n\n\
                        If there is only one entity identifier for the customer and\
                        \ the value is the same as `vat_number`, then there is no\
                        \ need to provide the `entity_identifiers[]` array. See [description\
                        \ for `entity_identifiers[]`](/docs/api/customers/customer-object#entity_identifiers).\n"
                      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: |
                      Resource object representing customer
                  card:
                    $ref: "#/components/schemas/Card"
                    description: |
                      Resource object representing card
                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:
      tags:
      - customers
      summary: Add contacts to a customer
      description: "Add a [contact](/docs/api/contacts) to a [customer](/docs/api/customers)\
        \ resource.  \n\n### Prerequisites \\& Constraints\n\n* The customer must\
        \ have fewer than 10 contacts already added.  \n\n### Impacts\n\n**Email notifications**\
        \  \n* If you set `contact[send_billing_email]` to `true`, the contact receives\
        \ [billing emails](https://www.chargebee.com/docs/billing/2.0/customers/customers#billing-emails).\n\
        * If you set `contact[send_account_email]` to `true`, the contact receives\
        \ [account emails](https://www.chargebee.com/docs/billing/2.0/customers/customers#account-emails).\
        \  \n\n### Implementation Notes\n\nCheck the customer's [`contacts[]`](/docs/api/customers/customer-object#contacts)\
        \ array and ensure it contains fewer than 10 contacts before calling this\
        \ API.\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing customer
                  card:
                    $ref: "#/components/schemas/Card"
                    description: |
                      Resource object representing card
                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:
      tags:
      - customers
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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:
      tags:
      - customers
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing customer
                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:
      tags:
      - customers
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing customer
                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:
      tags:
      - customers
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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\n* grab_pay - Payments made\
                        \ via GrabPay\n* sepa_instant_transfer - Payments made via\
                        \ Sepa Instant Transfer\n* go_pay - Payments made via GoPay\n\
                        * dotpay - Payments made via Dotpay.\n* p24 - Payments made\
                        \ via Przelewy24 (P24).\n* nequi - Payments made via Nequi.\n\
                        * google_pay - Payments made via Google Pay.\n* klarna - Payments\
                        \ made via Klarna.\n* paypal_express_checkout - Payments made\
                        \ via PayPal Express Checkout.\n* after_pay - Payments made\
                        \ via Afterpay\n* qpay - Payments made via Qpay.\n* ideal\
                        \ - Payments made via iDEAL.\n* pix - Payments made via Pix\n\
                        * pay_by_bank - Pay By Bank\n* sofort - Payments made via\
                        \ Sofort.\n* twint - Payments made via Twint\n* affirm_pay\
                        \ - Payments made via Affirm Pay.\n* electronic_payment_standard\
                        \ - Electronic Payment Standard\n* generic - Payments made\
                        \ via Generic Payment Method.\n* klarna_pay_now - Payments\
                        \ made via Klarna Pay Now\n* netbanking_emandates - Netbanking\
                        \ (eMandates) Payments.\n* apple_pay - Payments made via Apple\
                        \ Pay.\n* unionpay - Payments made via UnionPay.\n* faster_payments\
                        \ - Payments made via Faster Payments\n* thai_qr - Payments\
                        \ made via Thai QR.\n* swish - Payments made via Swish\n*\
                        \ venmo - Payments made via Venmo\n* giropay - Payments made\
                        \ via giropay.\n* payconiq_by_bancontact - Payments made via\
                        \ Payconiq by Bancontact.\n* naver_pay - Payments made via\
                        \ Naver Pay.\n* wero - Payments made via Wero.\n* touch_n_go\
                        \ - Payments made via Touch 'n Go.\n* direct_debit - Represents\
                        \ bank account for which the direct debit or ACH agreement/mandate\
                        \ is created.\n* rakuten_pay - Payments made via Rakuten Pay.\n\
                        * ovo - Payments made via OVO.\n* momo - Payments made via\
                        \ MoMo.\n* mercado_pago - Payments made via Mercado Pago.\n\
                        * paypay - Payments made via PayPay\n* south_korean_cards\
                        \ - Payments made via South Korean Cards\n* blik - Payments\
                        \ made via BLIK.\n* dana - Payments made via Dana.\n* bancontact\
                        \ - Payments made via Bancontact Card.\n* automated_bank_transfer\
                        \ - Represents virtual bank account using which the payment\
                        \ will be done.\n* upi - UPI Payments.\n* revolut_pay - Payments\
                        \ made via Revolut Pay.\n* amazon_payments - Payments made\
                        \ via Amazon Payments.\n* gcash - Payments made via GCash.\n\
                        * card - Card based payment including credit cards and debit\
                        \ cards. Details about the card can be obtained from the card\
                        \ resource.\n* stablecoin - Payments made via Stablecoin.\n\
                        * alipay -\n  Payments made via Alipay.  \n  This payment\
                        \ source is deprecated.\n* tamara - Payments made via Tamara.\n\
                        * payme - Payments made via PayMe\n* online_banking_poland\
                        \ - Payments made via Online Banking Poland\n* pay_to - Payments\
                        \ made via PayTo\n* nupay - Payments made via NuPay.\n* pay_co\
                        \ - Payments made via PayCo\n* picpay - Payments made via\
                        \ PicPay.\n* trustly - Trustly\n* kbc_payment_button - KBC\
                        \ Payment Button\n* kakao_pay - Payments made via Kakao Pay.\n\
                        * alipay_hk - Payments made via Alipay HK.\n* fpx - Payments\
                        \ made via FPX.\n* wechat_pay -\n  Payments made via WeChat\
                        \ Pay.  \n  This payment source is deprecated.\n* cash_app_pay\
                        \ - Payments 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
                      - alipay_hk
                      - paypay
                      - gcash
                      - south_korean_cards
                      - paynow
                      - bizum
                      - promptpay
                      - dana
                      - touch_n_go
                      - tamara
                      - qpay
                      - ovo
                      - momo
                      - mercado_pago
                      - nequi
                      - nupay
                      - picpay
                      - thai_qr
                      - blik
                      - fpx
                      - wero
                      - p24
                      - affirm_pay
                      - rakuten_pay
                      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: |
                        * `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal).

                          * `payer`: User related information.
                            * `country_of_residence`: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a [two-character ISO code](https://docs.checkout.com/resources/codes/country-codes).
                            * `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
                        * `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
                        * `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user's `device_session_id` can be added to perform [additional validation](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                            * `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
                        * `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
                        * `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                        * `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.

                          * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
                        * `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.

                          * `payer`: User related information.
                            * `document`: Document is the user's identification number based on their country.
                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device
                      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 supported\
                        \ only for Stripe, Adyen, and Chargebee Payments.\n\n* cartes_bancaires\
                        \ - A Cartes Bancaires card scheme.\n* mastercard - A MasterCard\
                        \ scheme.\n* dankort - A Dankort card scheme. Supported only\
                        \ for Adyen and Chargebee Payments.\n* visa - A Visa card\
                        \ scheme.\n"
                      enum:
                      - cartes_bancaires
                      - mastercard
                      - visa
                      - dankort
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `billing_state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    billing_state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `billing_state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      maxLength: 50
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |
                        * `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal).

                          * `payer`: User related information.
                            * `country_of_residence`: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a [two-character ISO code](https://docs.checkout.com/resources/codes/country-codes).
                            * `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
                        * `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
                        * `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user's `device_session_id` can be added to perform [additional validation](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                            * `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
                        * `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
                        * `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                        * `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.

                          * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
                        * `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.

                          * `payer`: User related information.
                            * `document`: Document is the user's identification number based on their country.
                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device
                      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
                        * klarna - Payments made via Klarna.
                        * payme - Payments made via PayMe
                        * thai_qr - Payments made via Thai QR.
                        * 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.
                        * tamara - Payments made via Tamara.
                        * ideal - ideal
                        * picpay - Payments made via PicPay.
                        * pay_to - PayTo
                        * ovo - Payments made via OVO.
                        * boleto - boleto
                        * pay_co - Payments made via PayCo
                        * wechat_pay - Payments made via WeChat Pay.
                        * cash_app_pay - Payments made via Cash App Pay.
                        * rakuten_pay - Payments made via Rakuten Pay.
                        * alipay_hk - Payments made via Alipay HK.
                        * after_pay - Payments made via Afterpay
                        * netbanking_emandates - netbanking_emandates
                        * nequi - Payments made via Nequi.
                        * grab_pay - Payments made via GrabPay
                        * paypay - PayPay
                        * payconiq_by_bancontact - Payments made via Payconiq by Bancontact.
                        * mercado_pago - Payments made via Mercado Pago.
                        * p24 - Payments made via Przelewy24 (P24).
                        * electronic_payment_standard - Electronic Payment Standard
                        * direct_debit - direct_debit
                        * sepa_instant_transfer - Sepa Instant Transfer
                        * bancontact - bancontact
                        * wero - Payments made via Wero.
                        * pay_by_bank - Pay By Bank
                        * touch_n_go - Payments made via Touch 'n Go.
                        * apple_pay - apple_pay
                        * qpay - Payments made via Qpay.
                        * online_banking_poland - Online Banking Poland
                        * gcash - Payments made via GCash.
                        * nupay - Payments made via NuPay.
                        * giropay - giropay
                        * momo - Payments made via MoMo.
                        * sofort - sofort
                        * amazon_payments - Amazon Payments
                        * affirm_pay - Payments made via Affirm Pay.
                        * kakao_pay - Payments made via Kakao Pay.
                        * fpx - Payments made via FPX.
                        * blik - Payments made via BLIK.
                        * dana - Payments made via Dana.
                        * south_korean_cards - Payments made via South Korean Cards
                        * 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
                      - alipay_hk
                      - paypay
                      - gcash
                      - south_korean_cards
                      - paynow
                      - bizum
                      - promptpay
                      - dana
                      - touch_n_go
                      - tamara
                      - qpay
                      - ovo
                      - momo
                      - mercado_pago
                      - nequi
                      - nupay
                      - picpay
                      - thai_qr
                      - blik
                      - fpx
                      - wero
                      - p24
                      - affirm_pay
                      - rakuten_pay
                      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: |
                        * `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal).

                          * `payer`: User related information.
                            * `country_of_residence`: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a [two-character ISO code](https://docs.checkout.com/resources/codes/country-codes).
                            * `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
                        * `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
                        * `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user's `device_session_id` can be added to perform [additional validation](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                            * `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
                        * `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
                        * `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                        * `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.

                          * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
                        * `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.

                          * `payer`: User related information.
                            * `document`: Document is the user's identification number based on their country.
                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device
                      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: |
                      Resource object representing customer
                  transaction:
                    $ref: "#/components/schemas/Transaction"
                    description: |
                      Resource object representing transaction
                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:
      tags:
      - customers
      summary: Record an excess payment for a customer
      description: "Records an offline payment for a customer and adds it to the customer's\
        \ [excess payments balance](/docs/api/customers#balances).  \n\n### Impacts\n\
        \n**Invoices**  \n* Chargebee automatically applies excess payments to future\
        \ invoices, subject to [limits set at the site level](https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/credit-notes#credits-flexibility)\
        \ or overridden for subscriptions via [`subscription.billing_override`](/docs/api/subscriptions#billing_override).\n\
        * Use the [Apply payments to an invoice API](/docs/api/invoices/apply-payments-for-an-invoice)\
        \ to apply excess payments to an invoice on an ad-hoc basis.  \n\n#### Related\
        \ APIs\n\n[Apply payments for an invoice](/docs/api/invoices?prod_cat_ver=2#apply_payments_for_an_invoice)\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
                      description: "The unique ID of the transaction.  \n**Constraints**\n\
                        \n* The value must be unique within the site; it should not\
                        \ collide with any existing transaction ID.\n"
                      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: "The payment method of this transaction\n\n* cash\
                        \ - Cash\n* other - Payment Methods other than the above types\n\
                        * custom -\n  Custom payment method.  \n  **Prerequisite**\n\
                        \n  * [Custom payment methods](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/custom-payment-methods&ref=feature)\
                        \ must be enabled in Chargebee Billing.\n* check - Check\n\
                        * bank_transfer - Bank Transfer\n"
                      enum:
                      - cash
                      - check
                      - bank_transfer
                      - other
                      - custom
                      - tamara
                      - qpay
                      - blik
                      - fpx
                      - wero
                      - p24
                      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.  \n**Prerequisite**\n\n* The `transaction[payment_method]`\
                        \ is `custom`.\n"
                      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: |
                      Resource object representing customer
                  transaction:
                    $ref: "#/components/schemas/Transaction"
                    description: |
                      Resource object representing transaction
                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}/send_payment_request:
    post:
      tags:
      - customers
      summary: Send Payment Request Email
      description: "Sends a request payment email to the customer using the site's\
        \ published **Collect Payment Email** Engage notification template.\n\nUse\
        \ this operation to manually trigger a payment request email when you want\
        \ the customer to pay outstanding invoices.  \n**Async-only**\nThis operation\
        \ is [asynchronous only](/docs/api/async_response). You must send `Prefer:\
        \ respond-async`, a unique `chargebee-request-id`, and a `chargebee-async-callback-url`.\
        \ The HTTP response is `202 Accepted` with an empty body. When processing\
        \ completes, Chargebee delivers the outcome to your [async callback URL](/docs/api/async_response)\
        \ --- a successful `result` contains [`email_logs`](/docs/api/email_logs).\
        \  \n\n### Prerequisites \\& Constraints\n\n* Email Engage V2 must be enabled\
        \ for the site.\n* The **Collect Payment Email** notification template must\
        \ be published and enabled.\n* The from address configured for the notification\
        \ template must be verified.\n* The customer must have a valid email address.\n\
        * The customer must have at least one unpaid invoice.\n"
      operationId: send_payment_request_email
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: Prefer
        in: header
        description: Must be set to `respond-async`. Instructs Chargebee to process
          the request asynchronously and return `202 Accepted` immediately.
        required: true
        deprecated: false
        $ref: "#/components/parameters/Prefer"
        style: simple
        explode: false
        schema:
          type: string
          description: Must be set to `respond-async`. Instructs Chargebee to process
            the request asynchronously and return `202 Accepted` immediately.
          example: respond-async
      - name: chargebee-request-id
        in: header
        description: "A client-generated unique identifier (UUID recommended) for\
          \ this request. Echoed back as `request.id` in the async callback payload,\
          \ allowing you to correlate each callback to its originating request."
        required: true
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "A client-generated unique identifier (UUID recommended) for\
            \ this request. Echoed back as `request.id` in the async callback payload,\
            \ allowing you to correlate each callback to its originating request."
          example: 7c9e2f4a-8b1d-4e6f-9a0c-3d5e7f9b1c2d
          maxLength: 100
      - name: chargebee-async-callback-url
        in: header
        description: "The callback URL where Chargebee will `POST` the async result.\
          \ Must be an `https://` URL and may embed basic-auth credentials, e.g. `https://username:password@example.com`."
        required: true
        deprecated: false
        $ref: "#/components/parameters/chargebee-async-callback-url"
        style: simple
        explode: false
        schema:
          type: string
          format: uri
          description: "The callback URL where Chargebee will `POST` the async result.\
            \ Must be an `https://` URL and may embed basic-auth credentials, e.g.\
            \ `https://username:password@example.com`."
          example: https://username:password@example.com
      - 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:
                  email_logs:
                    type: array
                    description: |
                      List of [email log](/docs/api/email_logs) objects for the send request. Each entry describes one email that was sent or attempted.
                    items:
                      $ref: "#/components/schemas/EmailLog"
                      description: Resource object representing email_log
                    example: null
                required:
                - email_logs
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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:
      tags:
      - customers
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing customer
                  card:
                    $ref: "#/components/schemas/Card"
                    description: |
                      Resource object representing card
                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:
      tags:
      - customers
      summary: Update account hierarchy access settings for a customer
      description: "When the customer is part of an [account hierarchy](https://www.chargebee.com/docs/account-hierarchy.html),\
        \ this operation updates the access privileges that both the customer and\
        \ its parent have to the customer's data.  \n**Terminology**\nThe term \"\
        parent\" usually refers to the customer with the ID [payment_owner_id](/docs/api/customers/customer-object#relationship_payment_owner_id).\
        \ However, if the `payment_owner_id` is the same as the child's ID (given\
        \ by the path parameter), the \"parent\" is identified by [parent_id](/docs/api/customers/customer-object#relationship_parent_id).\
        \  \n**Tip**\nYou cannot use this endpoint to change the `parent_id`, `invoice_owner_id`\
        \ or `payment_owner_id` for the customer. To change them, [unlink the customer](/docs/api/customers/delink-a-customer)\
        \ and then call [Link a customer](/docs/api/customers/link-a-customer) with\
        \ the updated values.\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    Decides if Chargebee should apply settings from the [Chargebee Billing UI](https://www.chargebee.com/docs/2.0/account-hierarchy.html#advanced-mode) or from this API request.

                    * If set to `true`: Chargebee removes existing settings stored in the `parent_account_access` and `child_account_access` attributes of the customer. The settings configured in the Chargebee Billing UI apply for the customer.
                    * If set to `false`: Chargebee replaces existing settings stored in the `parent_account_access` and `child_account_access` parameters with those passed in this API call. If any of those parameters are not passed, they remain unchanged for the customer.
                  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: |
                        If `true`
                        , the parent account will receive subscription-related emails sent to the child account.
                      example: null
                    send_payment_emails:
                      type: boolean
                      deprecated: false
                      description: |
                        If `true`
                        , the parent account will receive payment-related emails sent to the child account.
                      example: null
                    send_invoice_emails:
                      type: boolean
                      deprecated: false
                      description: |
                        If `true`
                        , the parent account will receive invoice-related emails sent to the child account.
                      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/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: |
                        If `true`
                        , the child account receives email notifications for its subscriptions.
                      example: null
                    send_payment_emails:
                      type: boolean
                      deprecated: false
                      description: |
                        If `true`
                        , the child account receives email notifications for payment-related activities for its invoices.
                      example: null
                    send_invoice_emails:
                      type: boolean
                      deprecated: false
                      description: |
                        If `true`
                        , the child account receives email notifications for its invoices.
                      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: |
                      Resource object representing customer
                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:
      tags:
      - customers
      summary: Update billing info for a customer
      description: "Updates a customer's billing information, including billing address\
        \ and tax-related details such as VAT number.  \n**Note**\n\nSee **Related\
        \ APIs** for other customer attributes that can be updated.  \n\n### Prerequisites\
        \ \\& Constraints\n\nIn some cases, passing the following parameters can cause\
        \ the request to fail: `vat_number`, `business_customer_without_vat_number`,\
        \ `tax_providers_fields`, and `registered_for_gst`. See **Implementation Notes**\
        \ for more details.  \n\n### Impacts\n\n**Customer**  \nFor certain parameters,\
        \ if you do not include a parameter in the request, Chargebee removes the\
        \ corresponding attribute from the customer object. To retain an existing\
        \ attribute, you must explicitly include its parameter in your request.\n\n\
        ##### Parameters that are affected by this behavior\n\n* `billing_address.first_name`\n\
        * `billing_address.last_name`\n* `billing_address.phone`\n* `billing_address.email`\n\
        * `billing_address.line1`\n* `billing_address.line2`\n* `billing_address.line3`\n\
        * `billing_address.city`\n* `billing_address.state`\n* `billing_address.country`\n\
        * `billing_address.zip`\n* `vat_number`\n* `vat_number_prefix`\n* `business_customer_without_vat_number`\n\
        * `registered_for_gst`\n\n##### Example\n\nAssume the customer object has\
        \ these attributes set:\n\n**Current attributes:**\n\n* `billing_address.first_name`\n\
        * `billing_address.last_name`\n* `billing_address.phone`\n* `billing_address.email`\n\
        * `vat_number`\n\nYou make an API call with only the following parameters:\n\
        \n**Request parameters:**\n\n* `billing_address.first_name`\n* `billing_address.last_name`\n\
        * `billing_address.phone`\n\n**Result:** The `billing_address.email` and `vat_number`\
        \ attributes are removed from the customer object because they weren't included\
        \ in the request. To preserve these attributes, include them in the request.\
        \  \n**Invoices**  \n* Chargebee uses the `billing_address` object from the\
        \ customer to set the values in the [`billing_address`](/docs/api/invoices/invoice-object#billing_address)\
        \ of the invoices generated for the customer.\n* If the `billing_address`\
        \ object does not include the `first_name`, `last_name`, or `company` fields,\
        \ Chargebee automatically uses the values from [`customer.first_name`](/docs/api/customers/customer-object#first_name),\
        \ [`customer.last_name`](/docs/api/customers/customer-object#last_name), and\
        \ [`customer.company`](/docs/api/customers/customer-object#company) (if available)\
        \ when generating invoices.  \n\n### Implementation Notes\n\n* Ensure that\
        \ `vat_number` and `business_customer_without_vat_number` = `true` are not\
        \ passed together in the same request.\n* Ensure that `tax_providers_fields`\
        \ is not passed if [Indian GST](https://www.chargebee.com/docs/billing/2.0/taxes/indian-gst)\
        \ is not configured for your site.\n* Ensure that `registered_for_gst` = `true`\
        \ is not passed if [Australian GST](https://www.chargebee.com/docs/australian-gst.html)\
        \ is not configured for your site.  \n\n### Use Cases\n\nPrevent tax provider\
        \ errors due to missing billing information  \nAfter integrating [tax providers](https://www.chargebee.com/docs/billing/2.0/integrations/tax-integration-index),\
        \ you might encounter unintended tax calculation failures during renewals.\
        \ The error message typically states:\n> Unable to calculate the tax rate\
        \ as the shipping/billing address is either invalid or incomplete. Please\
        \ verify and try again.\n\nThis error can occur even if the [`is_taxable`](/docs/api/item_prices/update-an-item-price#is_taxable)\
        \ value of item prices is changed from `true` to `false` before subscription\
        \ renewal and reactivation.\n\n##### Solution\n\nUse this operation to update\
        \ the billing address attributes to ensure they are accurate and complete.\
        \  \n\n### Troubleshooting\n\nHere are some commonly encountered errors when\
        \ using this API, along with their resolutions  \nError: `400`: \"Operation\
        \ failed as the country entered in the billing address by the customer cannot\
        \ be verified against IP address or card BIN number.\"  \nThis error occurs\
        \ when location validation is enabled in the tax settings and there's a mismatch\
        \ between the customer's billing country and their IP address or the card\
        \ issuing country.\n\n##### Resolution\n\nChoose one of the following solutions:\n\
        \n**Option A: Fix IP address mismatch**\n\nUse the [Update a card payment\
        \ source API](/docs/api/payment_sources/update-a-card-payment-source) and\
        \ include the correct IP address in the [request header](/docs/api/advanced-features).\n\
        \n**Option B: Fix BIN mismatch**\n\nAsk the customer to update their payment\
        \ method with one whose BIN matches their country. You can do this using the\
        \ [Request Payment Method](https://www.chargebee.com/docs/billing/2.0/hosted-capabilities/manage-payment-sources)\
        \ option or the [Self-Serve Portal](/docs/api/customers/update-billing-info-for-a-customer).\n\
        \n**Option C: Disable location validation**\n\n1. In [Chargebee Billing](https://app.chargebee.com),\
        \ navigate to **Settings \\> Configure Chargebee \\> Taxes**.\n2. Select the\
        \ country.\n3. In the right pane, clear the **Enable location validation**\
        \ checkbox.  \n\n#### Related APIs\n\n[Update a customer](/docs/api/customers?prod_cat_ver=2#update_a_customer)[Link\
        \ a customer to an account](/docs/api/customers?prod_cat_ver=2#link_a_customer)[Unlink\
        \ a customer from its parent account](/docs/api/customers?prod_cat_ver=2#delink_a_customer)\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: "The VAT/tax registration number for the customer.\n\
                    For customers with [`billing_address`](/docs/api/customers/customer-object#billing_address)\
                    \ as `XI` (United Kingdom - Northern Ireland), the first two characters\
                    \ of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number)\
                    \ can be overridden by setting [`vat_number_prefix`](/docs/api/customers/customer-object#vat_number_prefix).\
                    \  \n**Warning**\n\n* If you don't pass this parameter, the value\
                    \ will be **deleted** from the customer object.\n* If you pass\
                    \ this parameter and also pass `business_customer_without_vat_number`\
                    \ = `true`, the request will fail.\n"
                  maxLength: 20
                  example: null
                vat_number_prefix:
                  type: string
                  deprecated: false
                  description: "An overridden value for the first two characters of\
                    \ the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number).\n\
                    Only applicable specifically for customers with [`billing_address`](/docs/api/customers/customer-object#billing_address)\
                    \ as `XI` (United Kingdom - Northern Ireland).  \n**Warning**\n\
                    If you don't pass this parameter, the value will be **deleted**\
                    \ from the customer object.\n"
                  maxLength: 10
                  example: null
                entity_identifier_scheme:
                  type: string
                  deprecated: false
                  description: "The Peppol BIS scheme associated with the [vat_number](/docs/api/customers/customer-object#vat_number)\n\
                    of the customer. This helps identify the specific type of customer\
                    \ entity. For example, `DE:VAT`\nis used for a German business\
                    \ entity while `DE:LWID45`\nis used for a German government entity.\
                    \ The value must be from the list of possible values and must\
                    \ correspond to the country provided under `billing_address.country`.\n\
                    See [list of possible values](https://www.chargebee.com/docs/e-invoicing.html#supported-countries)\n\
                    .  \n**Tip:**\n\nIf there are additional entity identifiers for\
                    \ the customer not associated with the `vat_number`, they can\
                    \ be provided as the `entity_identifiers[]` array.\n"
                  maxLength: 50
                  example: null
                entity_identifier_standard:
                  type: string
                  default: iso6523-actorid-upis
                  deprecated: false
                  description: "The standard used for specifying the `entity_identifier_scheme`.\n\
                    Currently only `iso6523-actorid-upis`\nis supported and is used\
                    \ by default when not provided.  \n**Tip:**\n\nIf there are additional\
                    \ entity identifiers for the customer not associated with the\
                    \ `vat_number`, they can be provided as the `entity_identifiers[]`\
                    \ array.\n"
                  maxLength: 50
                  example: null
                registered_for_gst:
                  type: boolean
                  deprecated: false
                  description: "Confirms that a customer is registered under GST.\
                    \ If set to `true` then the [Reverse Charge Mechanism](https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism)\
                    \ is applicable. This field is applicable only when Australian\
                    \ GST is configured for your site.  \n**Warning**\n\n* If you\
                    \ don't pass this parameter, the value will be **deleted** from\
                    \ the customer object.\n* If you pass this parameter as `true`\
                    \ and Australian GST is not configured for your site, the request\
                    \ will fail.\n"
                  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.  \n**Warning**\n\n* If you don't pass this\
                    \ parameter, the value will be **deleted** from the customer object.\n\
                    * If you pass this parameter as `true` and also pass `vat_number`,\
                    \ the request will fail.\n"
                  example: null
                is_einvoice_enabled:
                  type: boolean
                  deprecated: false
                  description: "Determines whether the customer is e-invoiced. When\
                    \ set to `true`\nor not set to any value, the customer is e-invoiced\
                    \ so long as e-invoicing is enabled for their country (`billing_address.country`\n\
                    ). When set to `false`\n, the customer is not e-invoiced even\
                    \ if e-invoicing is enabled for their country.  \n**Tip:**\n\n\
                    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.\n"
                  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.  \n**Warning**\n\
                        If you don't pass this parameter, the value will be **deleted**\
                        \ from the customer object.\n"
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: "The last name of the billing contact.  \n**Warning**\n\
                        If you don't pass this parameter, the value will be **deleted**\
                        \ from the customer object.\n"
                      maxLength: 150
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: "The email address.  \n**Warning**\nIf you don't\
                        \ pass this parameter, the value will be **deleted** from\
                        \ the customer object.\n"
                      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.  \n**Warning**\nIf you don't\
                        \ pass this parameter, the value will be **deleted** from\
                        \ the customer object.\n"
                      maxLength: 50
                      example: null
                    line1:
                      type: string
                      deprecated: false
                      description: "Address line 1.  \n**Warning**\nIf you don't pass\
                        \ this parameter, the value will be **deleted** from the customer\
                        \ object.\n"
                      maxLength: 150
                      example: null
                    line2:
                      type: string
                      deprecated: false
                      description: "Address line 2.  \n**Warning**\nIf you don't pass\
                        \ this parameter, the value will be **deleted** from the customer\
                        \ object.\n"
                      maxLength: 150
                      example: null
                    line3:
                      type: string
                      deprecated: false
                      description: "Address line 3.  \n**Warning**\nIf you don't pass\
                        \ this parameter, the value will be **deleted** from the customer\
                        \ object.\n"
                      maxLength: 150
                      example: null
                    city:
                      type: string
                      deprecated: false
                      description: "The name of the city.  \n**Warning**\nIf you don't\
                        \ pass this parameter, the value will be **deleted** from\
                        \ the customer object.\n"
                      maxLength: 50
                      example: null
                    state_code:
                      type: string
                      deprecated: false
                      description: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code) without the country prefix. Currently supported for USA, Canada, India and UAE.
                        For example:

                        * For Arizona (USA), set `state_code` as `AZ` (not `US-AZ`).
                        * For Tamil Nadu (India), set as `TN` (not `IN-TN`).
                        * For British Columbia (Canada), set as `BC` (not `CA-BC`).
                        * For Dubai (UAE), set as `DU` (not `AE-DU`).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: "The state/province name.  \n**Warning**\nIf you\
                        \ don't pass this parameter, the value will be **deleted**\
                        \ from the customer object.  \n**Note**\nIf you don't pass\
                        \ this parameter, the value will be set by Chargebee automatically\
                        \ for US, Canada, India and UAE, if `state_code`\nis provided.\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://chromium-i18n.appspot.com/ssl-address).\
                        \  \n**Warning**\nIf you don't pass this parameter, the value\
                        \ will be **deleted** from the customer object.\n"
                      maxLength: 20
                      example: null
                    country:
                      type: string
                      deprecated: false
                      description: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements).\
                        \  \n**Warning**\nIf you don't pass this parameter, the value\
                        \ will be **deleted** from the customer object.  \n**Brexit**\n\
                        If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\
                        \  \n**E-Invoicing**\nIf `country` is provided as different\
                        \ from the existing value and if `entity_identifier_scheme`,\
                        \ `entity_identifier_standard`, and `entity_identifier` already\
                        \ exist and are not provided for this operation, they're cleared.\n"
                      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: |
                        The unique id for the `entity_identifier[i]` in Chargebee. This is required when `entity_identifier[operation][i]` is `update` or `delete`.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    scheme:
                      type: array
                      description: "The Peppol BIS scheme associated with the [`vat_number`](/docs/api/customers/customer-object#vat_number)\
                        \ of the customer. This helps identify the specific type of\
                        \ customer entity. For example, `DE:VAT` is used for a German\
                        \ business entity while `DE:LWID45` 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 `billing_address.country`.\
                        \ See [list of possible values](https://www.chargebee.com/docs/e-invoicing.html#supported-countries).\
                        \  \n**Tip**\nIf there is only one entity identifier for the\
                        \ customer and the value is the same as `vat_number`, then\
                        \ there is no need to provide the `entity_identifiers[]` array.\
                        \ See [`entity_identifiers[]`](customers#customer_entity_identifiers)\
                        \ description.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    value:
                      type: array
                      description: "The value of the `entity_identifier`.\nThis identifies\
                        \ the customer entity on the Peppol network. For example:\
                        \ `10101010-STO-10`\n.  \n**Tip:**\n\nIf there is only one\
                        \ entity identifier for the customer and the value is the\
                        \ same as `vat_number`, then there is no need to provide the\
                        \ `entity_identifiers[]` array. See [description for `entity_identifiers[]`](/docs/api/customers/customer-object#entity_identifiers).\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    operation:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The operation to be performed for the `entity_identifier`.

                          * update - Updates an existing `entity_identifier` for the customer. `entity_identifier[id]` must be provided in this case.
                          * delete - Deletes an existing `entity_identifier` for the customer. `entity_identifier[id]` must be provided in this case.
                          * create - Creates a new `entity_identifier` for the customer.
                        enum:
                        - create
                        - update
                        - delete
                        example: null
                      example: null
                    standard:
                      type: array
                      description: "The standard used for specifying the `entity_identifier`\n\
                        `scheme`.\nCurrently, only `iso6523-actorid-upis`\nis supported\
                        \ and is used by default when not provided.  \n**Tip:**\n\n\
                        If there is only one entity identifier for the customer and\
                        \ the value is the same as `vat_number`, then there is no\
                        \ need to provide the `entity_identifiers[]` array. See [description\
                        \ for `entity_identifiers[]`](/docs/api/customers/customer-object#entity_identifiers).\n"
                      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.  \n**Note**\n\
                    This parameter is supported only when selling to [India-SEZ](https://www.chargebee.com/docs/billing/2.0/taxes/indian-gst#configuring-taxes-for-special-economic-zones-sezs)\
                    \ customers or when you're an [Indian business that sells to customers\
                    \ outside India](https://www.chargebee.com/docs/billing/2.0/taxes/indian-gst#configuring-taxes-for-exports).\n"
                  properties:
                    provider_name:
                      type: array
                      description: "Name of the tax provider.  \n**Note**\nThis parameter\
                        \ is supported only when selling to [India-SEZ](https://www.chargebee.com/docs/billing/2.0/taxes/indian-gst#configuring-taxes-for-special-economic-zones-sezs)\
                        \ customers or when you're an [Indian business that sells\
                        \ to customers outside India](https://www.chargebee.com/docs/billing/2.0/taxes/indian-gst#configuring-taxes-for-exports).\n"
                      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.  \n**Note**\n\
                        This parameter is supported only when selling to [India-SEZ](https://www.chargebee.com/docs/billing/2.0/taxes/indian-gst#configuring-taxes-for-special-economic-zones-sezs)\
                        \ customers or when you're an [Indian business that sells\
                        \ to customers outside India](https://www.chargebee.com/docs/billing/2.0/taxes/indian-gst#configuring-taxes-for-exports).\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    field_value:
                      type: array
                      description: "The value of the related tax field.  \n**Note**\n\
                        This parameter is supported only when selling to [India-SEZ](https://www.chargebee.com/docs/billing/2.0/taxes/indian-gst#configuring-taxes-for-special-economic-zones-sezs)\
                        \ customers or when you're an [Indian business that sells\
                        \ to customers outside India](https://www.chargebee.com/docs/billing/2.0/taxes/indian-gst#configuring-taxes-for-exports).\n"
                      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: |
                      Resource object representing customer
                  card:
                    $ref: "#/components/schemas/Card"
                    description: |
                      Resource object representing card
                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:
      tags:
      - tokens
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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\n* google_pay\
                    \ - Payments made via Google Pay.\n* pay_co - Payments made via\
                    \ PayCo\n* tamara - Payments made via Tamara.\n* alipay_hk - Payments\
                    \ made via Alipay HK.\n* ovo - Payments made via OVO.\n* apple_pay\
                    \ - Payments made via Apple Pay.\n* unionpay - Payments made via\
                    \ UnionPay.\n* ideal - Payments made via iDEAL.\n* bancontact\
                    \ - Payments made via Bancontact Card.\n* nequi - Payments made\
                    \ via Nequi.\n* netbanking_emandates - Netbanking (eMandates)\
                    \ Payments.\n* trustly - Trustly\n* after_pay - Payments made\
                    \ via Afterpay\n* alipay -\n  Payments made via Alipay.  \n  This\
                    \ payment source is deprecated.\n* picpay - Payments made via\
                    \ PicPay.\n* dotpay - Payments made via Dotpay.\n* giropay - Payments\
                    \ made via giropay.\n* fpx - Payments made via FPX.\n* sofort\
                    \ - Payments made via Sofort.\n* momo - Payments made via MoMo.\n\
                    * gcash - Payments made via GCash.\n* mercado_pago - Payments\
                    \ made via Mercado Pago.\n* nupay - Payments made via NuPay.\n\
                    * blik - Payments made via BLIK.\n* direct_debit - Represents\
                    \ bank account for which the direct debit or ACH agreement/mandate\
                    \ is created.\n* dana - Payments made via Dana.\n* paypal_express_checkout\
                    \ - Payments made via PayPal Express Checkout.\n* touch_n_go -\
                    \ Payments made via Touch 'n Go.\n* rakuten_pay - Payments made\
                    \ via Rakuten Pay.\n* qpay - Payments made via Qpay.\n* amazon_payments\
                    \ - Payments made via Amazon Payments.\n* electronic_payment_standard\
                    \ - Electronic Payment Standard\n* grab_pay - Payments made via\
                    \ GrabPay\n* card - Card based payment including credit cards\
                    \ and debit cards. Details about the card can be obtained from\
                    \ the card resource.\n* upi - UPI Payments.\n* affirm_pay - Payments\
                    \ made via Affirm Pay.\n* p24 - Payments made via Przelewy24 (P24).\n\
                    * thai_qr - Payments made via Thai QR.\n* wero - Payments made\
                    \ via Wero.\n* pay_by_bank - Pay By Bank\n* go_pay - Payments\
                    \ made via GoPay\n* swish - Payments made via Swish\n* twint -\
                    \ Payments made via Twint\n* generic - Payments made via Generic\
                    \ Payment Method.\n* payme - Payments made via PayMe\n* wechat_pay\
                    \ -\n  Payments made via WeChat Pay.  \n  This payment source\
                    \ is deprecated.\n* kbc_payment_button - KBC 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
                  - alipay_hk
                  - paypay
                  - gcash
                  - south_korean_cards
                  - paynow
                  - bizum
                  - promptpay
                  - dana
                  - touch_n_go
                  - tamara
                  - qpay
                  - ovo
                  - momo
                  - mercado_pago
                  - nequi
                  - nupay
                  - picpay
                  - thai_qr
                  - blik
                  - fpx
                  - wero
                  - p24
                  - affirm_pay
                  - rakuten_pay
                  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: |
                    * `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal).

                      * `payer`: User related information.
                        * `country_of_residence`: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a [two-character ISO code](https://docs.checkout.com/resources/codes/country-codes).
                        * `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
                    * `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.

                      * `fraud`: Fraud identification related information.
                        * `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
                    * `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user's `device_session_id` can be added to perform [additional validation](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.

                      * `fraud`: Fraud identification related information.
                        * `device_session_id`: Session ID associated with the user's device.
                        * `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
                    * `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.

                      * `fraud`: Fraud identification related information.
                        * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
                    * `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.

                      * `fraud`: Fraud identification related information.
                        * `device_session_id`: Session ID associated with the user's device.
                    * `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.

                      * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
                    * `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.

                      * `payer`: User related information.
                        * `document`: Document is the user's identification number based on their country.
                      * `fraud`: Fraud identification related information.
                        * `device_session_id`: Session ID associated with the user's device .
                  example: null
                browser_details:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ).
                      maxLength: 50
                      example: null
                    country_code:
                      type: string
                      deprecated: false
                      description: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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: |
                      Resource object representing token
                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:
      tags:
      - tokens
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                browser_details:
                  type: object
                  additionalProperties: true
                  deprecated: 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 supported\
                        \ only for Stripe, Adyen, and Chargebee Payments.\n\n* cartes_bancaires\
                        \ - A Cartes Bancaires card scheme.\n* mastercard - A MasterCard\
                        \ scheme.\n* dankort - A Dankort card scheme. Supported only\
                        \ for Adyen and Chargebee Payments.\n* mada - A Mada card\
                        \ scheme.\n* visa - A Visa card scheme.\n"
                      enum:
                      - cartes_bancaires
                      - mastercard
                      - visa
                      - dankort
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `billing_state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ).
                      maxLength: 50
                      example: null
                    billing_state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `billing_state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      maxLength: 50
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |
                        * `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal).

                          * `payer`: User related information.
                            * `country_of_residence`: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a [two-character ISO code](https://docs.checkout.com/resources/codes/country-codes).
                            * `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
                        * `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
                        * `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user's `device_session_id` can be added to perform [additional validation](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                            * `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
                        * `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
                        * `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                        * `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.

                          * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
                        * `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.

                          * `payer`: User related information.
                            * `document`: Document is the user's identification number based on their country.
                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device
                      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
                      description: |
                        Email address of the cardholder. Required by some gateways when creating a card token.
                      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: |
                      Resource object representing token
                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:
      tags:
      - tokens
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - 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: |
                      Resource object representing token
                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:
      tags:
      - payment_sources
      summary: Create using permanent token
      description: "Creates a payment source for a [customer](/docs/api/customers)\
        \ using a permanent token obtained from the [payment gateway](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/gateway_settings).\n\
        \nUse this API to add a payment method that has already been vaulted in your\
        \ gateway account. The permanent token enables Chargebee to securely link\
        \ the payment method to the customer. This enables payment collection for\
        \ future charges (both recurring and one-time) without requiring the customer\
        \ to re-enter their payment details.  \n\n### Prerequisites \\& Constraints\n\
        \n* The permanent token must belong to a gateway account configured in Chargebee.\n\
        * The token should be a **permanent/vault token**, not a single-use token.\n\
        * When multiple gateway accounts are configured in [Chargebee Billing](https://app.chargebee.com),\
        \ you must pass the `gateway_account_id` parameter if:\n  * [Smart Routing](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/gateway_settings#smart-routing)\
        \ is not configured for the payment method.\n* Smart Routing is configured\
        \ for the payment method, but the selected gateway account does not match\
        \ the provided token.  \n\n### Impacts\n\n**Customer**  \nPass the [`replace_primary_payment_source`](/docs/api/payment_sources/create-using-permanent-token#replace_primary_payment_source)\
        \ parameter as `true` to update the customer's [`primary_payment_source_id`](/docs/api/payment_sources/export-payment-source).\
        \ Otherwise, the existing primary payment source will remain unchanged.\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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
                brand_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [brand](/docs/api/brands) this\
                    \ payment source should be linked to. Applicable only when multiple\
                    \ brands have been created for the site. This need not match the\
                    \ brand of the `customer_id`; when the two differ, the value provided\
                    \ here is used for the payment source. An alternative way of passing\
                    \ this parameter is by means of the `chargebee-brand-id` custom\
                    \ HTTP header; when both are provided, they must specify the same\
                    \ brand.  \n**Default behavior**\n\n* When not provided, the payment\
                    \ source is linked to the brand of the customer it is created\
                    \ for.\n"
                  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\n* direct_debit - Represents bank\
                    \ account for which the direct debit or ACH agreement/mandate\
                    \ is created.\n* unionpay - Payments made via UnionPay.\n* ovo\
                    \ - Payments made via OVO.\n* google_pay - Payments made via Google\
                    \ Pay.\n* mercado_pago - Payments made via Mercado Pago.\n* sepa_instant_transfer\
                    \ - Payments made via Sepa Instant Transfer\n* dotpay - Payments\
                    \ made via Dotpay.\n* pay_to - Payments made via PayTo\n* klarna\
                    \ - Payments made via Klarna.\n* revolut_pay - Payments made via\
                    \ Revolut Pay.\n* thai_qr - Payments made via Thai QR.\n* naver_pay\
                    \ - Payments made via Naver Pay.\n* giropay - Payments made via\
                    \ giropay.\n* grab_pay - Payments made via GrabPay\n* rakuten_pay\
                    \ - Payments made via Rakuten Pay.\n* blik - Payments made via\
                    \ BLIK.\n* stablecoin - Payments made via Stablecoin.\n* alipay\
                    \ -\n  Payments made via Alipay.  \n  This payment source is deprecated.\n\
                    * kakao_pay - Payments made via Kakao Pay.\n* sofort - Payments\
                    \ made via Sofort.\n* gcash - Payments made via GCash.\n* dana\
                    \ - Payments made via Dana.\n* pix - Payments made via Pix\n*\
                    \ p24 - Payments made via Przelewy24 (P24).\n* pay_co - Payments\
                    \ made via PayCo\n* wechat_pay -\n  Payments made via WeChat Pay.\
                    \  \n  This payment source is deprecated.\n* netbanking_emandates\
                    \ - Netbanking (eMandates) Payments.\n* nupay - Payments made\
                    \ via NuPay.\n* picpay - Payments made via PicPay.\n* bancontact\
                    \ - Payments made via Bancontact Card.\n* go_pay - Payments made\
                    \ via GoPay\n* nequi - Payments made via Nequi.\n* card - Card\
                    \ based payment including credit cards and debit cards. Details\
                    \ about the card can be obtained from the card resource.\n* amazon_payments\
                    \ - Payments made via Amazon Payments.\n* pay_by_bank - Pay By\
                    \ Bank\n* online_banking_poland - Payments made via Online Banking\
                    \ Poland\n* touch_n_go - Payments made via Touch 'n Go.\n* after_pay\
                    \ - Payments made via Afterpay\n* faster_payments - Payments made\
                    \ via Faster Payments\n* alipay_hk - Payments made via Alipay\
                    \ HK.\n* momo - Payments made via MoMo.\n* fpx - Payments made\
                    \ via FPX.\n* paypay - Payments made via PayPay\n* generic - Payments\
                    \ made via Generic Payment Method.\n* payme - Payments made via\
                    \ PayMe\n* tamara - Payments made via Tamara.\n* klarna_pay_now\
                    \ - Payments made via Klarna Pay Now\n* twint - Payments made\
                    \ via Twint\n* swish - Payments made via Swish\n* automated_bank_transfer\
                    \ - Represents virtual bank account using which the payment will\
                    \ be done.\n* paypal_express_checkout - Payments made via PayPal\
                    \ Express Checkout.\n* venmo - Payments made via Venmo\n* ideal\
                    \ - Payments made via iDEAL.\n* trustly - Trustly\n* upi - UPI\
                    \ Payments.\n* wero - Payments made via Wero.\n* kbc_payment_button\
                    \ - KBC Payment Button\n* cash_app_pay - Payments made via Cash\
                    \ App Pay.\n* payconiq_by_bancontact - Payments made via Payconiq\
                    \ by Bancontact.\n* south_korean_cards - Payments made via South\
                    \ Korean Cards\n* qpay - Payments made via Qpay.\n* affirm_pay\
                    \ - Payments made via Affirm Pay.\n* apple_pay - Payments made\
                    \ via Apple Pay.\n* electronic_payment_standard - Electronic 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
                  - alipay_hk
                  - paypay
                  - gcash
                  - south_korean_cards
                  - paynow
                  - bizum
                  - promptpay
                  - dana
                  - touch_n_go
                  - tamara
                  - qpay
                  - ovo
                  - momo
                  - mercado_pago
                  - nequi
                  - nupay
                  - picpay
                  - thai_qr
                  - blik
                  - fpx
                  - wero
                  - p24
                  - affirm_pay
                  - rakuten_pay
                  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: "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 a card, this\
                    \ will be the identifier provided by the gateway or card vault\
                    \ for the specific payment method resource.  \n**Note:**\n\n*\
                    \ This is not the one-time temporary token provided by gateways\
                    \ like Stripe.\n\n* `reference_id` is an alternative for `payment_method_token`,\
                    \ `customer_profile_token`, `network_transaction_id`, or `mandate_id`.\n\
                    \n* `payment_method_token`, `customer_profile_token`, `network_transaction_id`,\
                    \ or `mandate_id` cannot be used with `reference_id`.\n\n* `reference_id`\
                    \ is a combination of multiple tokens available at the gateway.\
                    \ Learn more about the combination of each gateway from this [document](/docs/api/payment_parameters).\n\
                    \n"
                  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: "An identifier provided by the gateway or card vault\
                    \ for the specific payment method resource.  \n**Note:**\n`payment_method_token`\
                    \ is an alternative for reference_id and cannot be used with `reference_id`.\n"
                  maxLength: 100
                  example: null
                customer_profile_token:
                  type: string
                  deprecated: false
                  description: "A unique identifier associated with a customer\\`s\
                    \ profile within a payment gateway.  \n**Note:**\n`customer_profile_token`\
                    \ is an alternative for reference_id and cannot be used with `reference_id`.\n"
                  maxLength: 100
                  example: null
                network_transaction_id:
                  type: string
                  deprecated: false
                  description: "An identifier of the payment or authorization transaction\
                    \ at the gateway initiated using this payment method.  \n**Note:**\n\
                    `network_transaction_id` is an alternative for reference_id and\
                    \ cannot be used with `reference_id`.\n"
                  maxLength: 100
                  example: null
                mandate_id:
                  type: string
                  deprecated: false
                  description: "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.  \n**Note:**\n`mandate_id`\
                    \ is an alternative for reference_id and cannot be used with `reference_id`.\n"
                  maxLength: 100
                  example: null
                skip_retrieval:
                  type: boolean
                  default: false
                  deprecated: false
                  description: "By default, the value is `false` and payment method\
                    \ details will be retrieved from the selected payment gateway\
                    \ using `reference_id` or `payment_method_token` / `customer_profile_token`\
                    \ / `network_transaction_id` / `mandate_id`. Learn more about\
                    \ the multiple token combinations of each gateway from this [document](/docs/api/payment_parameters).\n\
                    Enter the value as `true` 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 `payment_method_token`, `customer_profile_token`, `network_transaction_id`,\
                    \ `mandate_id`, `card`, and `billing_address`.  \n**Note:**\n\
                    Currently, the `skip_retrieval` value as `true` is only supported\
                    \ for the Vantiv payment gateway.\n"
                  example: null
                additional_information:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    * `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://docs.checkout.com/payment-methods/cards/dlocal).

                      * `payer`: User related information.
                        * `country_of_residence`: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a [two-character ISO code](https://docs.checkout.com/resources/codes/country-codes).
                        * `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
                    * `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.

                      * `fraud`: Fraud identification related information.
                        * `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
                    * `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user's `device_session_id` can be added to perform [additional validation](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.

                      * `fraud`: Fraud identification related information.
                        * `device_session_id`: Session ID associated with the user's device.
                        * `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
                    * `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.

                      * `fraud`: Fraud identification related information.
                        * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
                    * `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.

                      * `fraud`: Fraud identification related information.
                        * `device_session_id`: Session ID associated with the user's device.
                    * `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.

                      * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
                    * `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.

                      * `payer`: User related information.
                        * `document`: Document is the user's identification number based on their country.
                      * `fraud`: Fraud identification related information.
                        * `device_session_id`: Session ID associated with the user's device .
                  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.
                        * 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.
                        * hipercard - An Hipercard.
                        * other - Card belonging to types other than those listed above.
                        * bancontact - A Bancontact card.
                        * cmr_falabella - A CMR Falabella card.
                        * rupay - A Rupay card.
                        * nativa - A Nativa card.
                        * discover - A Discover card.
                        * 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.
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)\n\
                        .  \n**Brexit**\n\nIf you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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: |
                      Resource object representing customer
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: |
                      Resource object representing payment_source
                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:
      tags:
      - payment_sources
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing customer
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: |
                      Resource object representing payment_source
                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:
      tags:
      - payment_sources
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
                brand_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [brand](/docs/api/brands) this\
                    \ payment source should be linked to. Applicable only when multiple\
                    \ brands have been created for the site. This need not match the\
                    \ brand of the `customer_id`; when the two differ, the value provided\
                    \ here is used for the payment source. An alternative way of passing\
                    \ this parameter is by means of the `chargebee-brand-id` custom\
                    \ HTTP header; when both are provided, they must specify the same\
                    \ brand.  \n**Default behavior**\n\n* When not provided, the payment\
                    \ source is linked to the brand of the customer it is created\
                    \ for.\n"
                  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 supported\
                        \ only for Stripe, Adyen, and Chargebee Payments.\n\n* mastercard\
                        \ - A MasterCard scheme.\n* dankort - A Dankort card scheme.\
                        \ Supported only for Adyen and Chargebee Payments.\n* cartes_bancaires\
                        \ - A Cartes Bancaires card scheme.\n* visa - A Visa card\
                        \ scheme.\n"
                      enum:
                      - cartes_bancaires
                      - mastercard
                      - visa
                      - dankort
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `billing_state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    billing_state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `billing_state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      maxLength: 50
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |
                        * `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal).

                          * `payer`: User related information.
                            * `country_of_residence`: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a [two-character ISO code](https://docs.checkout.com/resources/codes/country-codes).
                            * `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
                        * `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
                        * `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user's `device_session_id` can be added to perform [additional validation](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                            * `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
                        * `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
                        * `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                        * `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.

                          * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
                        * `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.

                          * `payer`: User related information.
                            * `document`: Document is the user's identification number based on their country.
                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device
                      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: |
                      Resource object representing customer
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: |
                      Resource object representing payment_source
                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}/gateway_payment_method_tokens:
    get:
      tags:
      - payment_sources
      summary: List Gateway Payment Method Tokens For A Payment Source
      description: |
        Lists gateway payment method token mappings stored for this payment source. A payment source can have multiple gateway tokens when vaulting and backup gateway merchant-initiated transactions (MIT) are enabled.
      operationId: list_gateway_payment_method_tokens_for_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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: include_deleted
        in: query
        description: |
          Indicates whether to include deleted objects in the list. The deleted objects have the attribute '`deleted`' as '`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:
                        gateway_payment_method_token:
                          $ref: "#/components/schemas/GatewayPaymentMethodToken"
                          description: Resource object representing gateway_payment_method_token
                      required:
                      - gateway_payment_method_token
                      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}/verify_bank_account:
    post:
      tags:
      - payment_sources
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing payment_source
                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:
      tags:
      - payment_sources
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: subscription_id
        in: query
        description: |
          Unique subscription identifier that helps to retrieve the payment source of a subscription which has `mandate`
          associated to it.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          deprecated: false
          maxLength: 50
          example: null
      - name: include_deleted
        in: query
        description: |
          Indicates whether to include deleted objects in the list. The deleted objects have the attribute '`deleted`
          ' as '`true`
          '.
        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\] = "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, alipay_hk, gcash, ovo, momo, mercado_pago, nequi, nupay, picpay, thai_qr, blik, fpx, wero, p24, affirm_pay, rakuten_pay, dana, touch_n_go, tamara, qpay, 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
                * `alipay_hk` - Payments made via Alipay HK
                * `paypay` - Payments made via PayPay
                * `gcash` - Payments made via GCash
                * `south_korean_cards` - Payments made via South Korean Cards
                * `paynow` - Payments made via PayNow
                * `bizum` - Payments made via Bizum
                * `promptpay` - Payments made via PromptPay
                * `dana` - Payments made via Dana
                * `touch_n_go` - Payments made via Touch 'n Go
                * `tamara` - Payments made via Tamara
                * `qpay` - Payments made via Qpay
                * `ovo` - Payments made via OVO.
                * `momo` - Payments made via MoMo.
                * `mercado_pago` - Payments made via Mercado Pago.
                * `nequi` - Payments made via Nequi.
                * `nupay` - Payments made via NuPay.
                * `picpay` - Payments made via PicPay.
                * `thai_qr` - Payments made via Thai QR.
                * `blik` - Payments made via BLIK.
                * `fpx` - Payments made via FPX.
                * `wero` - Payments made via Wero.
                * `p24` - Payments made via Przelewy24 (P24).
                * `affirm_pay` - Payments made via Affirm Pay.
                * `rakuten_pay` - Payments made via Rakuten Pay.
              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
              - alipay_hk
              - paypay
              - gcash
              - south_korean_cards
              - paynow
              - bizum
              - promptpay
              - dana
              - touch_n_go
              - tamara
              - qpay
              - ovo
              - momo
              - mercado_pago
              - nequi
              - nupay
              - picpay
              - thai_qr
              - blik
              - fpx
              - wero
              - p24
              - affirm_pay
              - rakuten_pay
              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
                * `alipay_hk` - Payments made via Alipay HK
                * `paypay` - Payments made via PayPay
                * `gcash` - Payments made via GCash
                * `south_korean_cards` - Payments made via South Korean Cards
                * `paynow` - Payments made via PayNow
                * `bizum` - Payments made via Bizum
                * `promptpay` - Payments made via PromptPay
                * `dana` - Payments made via Dana
                * `touch_n_go` - Payments made via Touch 'n Go
                * `tamara` - Payments made via Tamara
                * `qpay` - Payments made via Qpay
                * `ovo` - Payments made via OVO.
                * `momo` - Payments made via MoMo.
                * `mercado_pago` - Payments made via Mercado Pago.
                * `nequi` - Payments made via Nequi.
                * `nupay` - Payments made via NuPay.
                * `picpay` - Payments made via PicPay.
                * `thai_qr` - Payments made via Thai QR.
                * `blik` - Payments made via BLIK.
                * `fpx` - Payments made via FPX.
                * `wero` - Payments made via Wero.
                * `p24` - Payments made via Przelewy24 (P24).
                * `affirm_pay` - Payments made via Affirm Pay.
                * `rakuten_pay` - Payments made via Rakuten Pay.
              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
              - alipay_hk
              - paypay
              - gcash
              - south_korean_cards
              - paynow
              - bizum
              - promptpay
              - dana
              - touch_n_go
              - tamara
              - qpay
              - ovo
              - momo
              - mercado_pago
              - nequi
              - nupay
              - picpay
              - thai_qr
              - blik
              - fpx
              - wero
              - p24
              - affirm_pay
              - rakuten_pay
              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
                * `alipay_hk` - Payments made via Alipay HK
                * `paypay` - Payments made via PayPay
                * `gcash` - Payments made via GCash
                * `south_korean_cards` - Payments made via South Korean Cards
                * `paynow` - Payments made via PayNow
                * `bizum` - Payments made via Bizum
                * `promptpay` - Payments made via PromptPay
                * `dana` - Payments made via Dana
                * `touch_n_go` - Payments made via Touch 'n Go
                * `tamara` - Payments made via Tamara
                * `qpay` - Payments made via Qpay
                * `ovo` - Payments made via OVO.
                * `momo` - Payments made via MoMo.
                * `mercado_pago` - Payments made via Mercado Pago.
                * `nequi` - Payments made via Nequi.
                * `nupay` - Payments made via NuPay.
                * `picpay` - Payments made via PicPay.
                * `thai_qr` - Payments made via Thai QR.
                * `blik` - Payments made via BLIK.
                * `fpx` - Payments made via FPX.
                * `wero` - Payments made via Wero.
                * `p24` - Payments made via Przelewy24 (P24).
                * `affirm_pay` - Payments made via Affirm Pay.
                * `rakuten_pay` - Payments made via Rakuten Pay.
              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
              - alipay_hk
              - paypay
              - gcash
              - south_korean_cards
              - paynow
              - bizum
              - promptpay
              - dana
              - touch_n_go
              - tamara
              - qpay
              - ovo
              - momo
              - mercado_pago
              - nequi
              - nupay
              - picpay
              - thai_qr
              - blik
              - fpx
              - wero
              - p24
              - affirm_pay
              - rakuten_pay
              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|alipay_hk|paypay|gcash|south_korean_cards|paynow|bizum|promptpay|dana|touch_n_go|tamara|qpay|ovo|momo|mercado_pago|nequi|nupay|picpay|thai_qr|blik|fpx|wero|p24|affirm_pay|rakuten_pay)(,(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|alipay_hk|paypay|gcash|south_korean_cards|paynow|bizum|promptpay|dana|touch_n_go|tamara|qpay|ovo|momo|mercado_pago|nequi|nupay|picpay|thai_qr|blik|fpx|wero|p24|affirm_pay|rakuten_pay))*\\\
                ]$"
              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
                * `alipay_hk` - Payments made via Alipay HK
                * `paypay` - Payments made via PayPay
                * `gcash` - Payments made via GCash
                * `south_korean_cards` - Payments made via South Korean Cards
                * `paynow` - Payments made via PayNow
                * `bizum` - Payments made via Bizum
                * `promptpay` - Payments made via PromptPay
                * `dana` - Payments made via Dana
                * `touch_n_go` - Payments made via Touch 'n Go
                * `tamara` - Payments made via Tamara
                * `qpay` - Payments made via Qpay
                * `ovo` - Payments made via OVO.
                * `momo` - Payments made via MoMo.
                * `mercado_pago` - Payments made via Mercado Pago.
                * `nequi` - Payments made via Nequi.
                * `nupay` - Payments made via NuPay.
                * `picpay` - Payments made via PicPay.
                * `thai_qr` - Payments made via Thai QR.
                * `blik` - Payments made via BLIK.
                * `fpx` - Payments made via FPX.
                * `wero` - Payments made via Wero.
                * `p24` - Payments made via Przelewy24 (P24).
                * `affirm_pay` - Payments made via Affirm Pay.
                * `rakuten_pay` - Payments made via Rakuten Pay.
              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
              - alipay_hk
              - paypay
              - gcash
              - south_korean_cards
              - paynow
              - bizum
              - promptpay
              - dana
              - touch_n_go
              - tamara
              - qpay
              - ovo
              - momo
              - mercado_pago
              - nequi
              - nupay
              - picpay
              - thai_qr
              - blik
              - fpx
              - wero
              - p24
              - affirm_pay
              - rakuten_pay
              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|alipay_hk|paypay|gcash|south_korean_cards|paynow|bizum|promptpay|dana|touch_n_go|tamara|qpay|ovo|momo|mercado_pago|nequi|nupay|picpay|thai_qr|blik|fpx|wero|p24|affirm_pay|rakuten_pay)(,(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|alipay_hk|paypay|gcash|south_korean_cards|paynow|bizum|promptpay|dana|touch_n_go|tamara|qpay|ovo|momo|mercado_pago|nequi|nupay|picpay|thai_qr|blik|fpx|wero|p24|affirm_pay|rakuten_pay))*\\\
                ]$"
              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\[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: 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\[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: 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:
      tags:
      - payment_sources
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing third_party_payment_method
                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:
      tags:
      - payment_sources
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
                brand_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [brand](/docs/api/brands) this\
                    \ payment source should be linked to. Applicable only when multiple\
                    \ brands have been created for the site. This need not match the\
                    \ brand of the `customer_id`; when the two differ, the value provided\
                    \ here is used for the payment source. An alternative way of passing\
                    \ this parameter is by means of the `chargebee-brand-id` custom\
                    \ HTTP header; when both are provided, they must specify the same\
                    \ brand.  \n**Default behavior**\n\n* When not provided, the payment\
                    \ source is linked to the brand of the customer it is created\
                    \ for.\n"
                  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.

                        * alipay_hk - Payments made via Alipay HK.
                        * card - card
                        * twint - Payments made via Twint
                        * swish - Payments made via Swish
                        * after_pay - Payments made via Afterpay
                        * netbanking_emandates - netbanking_emandates
                        * nequi - Payments made via Nequi.
                        * grab_pay - Payments made via GrabPay
                        * paypay - PayPay
                        * payconiq_by_bancontact - Payments made via Payconiq by Bancontact.
                        * dotpay - dotpay
                        * mercado_pago - Payments made via Mercado Pago.
                        * faster_payments - Faster Payments
                        * p24 - Payments made via Przelewy24 (P24).
                        * upi - upi
                        * kbc_payment_button - KBC Payment Button
                        * electronic_payment_standard - Electronic Payment Standard
                        * klarna - Payments made via Klarna.
                        * payme - Payments made via PayMe
                        * direct_debit - direct_debit
                        * sepa_instant_transfer - Sepa Instant Transfer
                        * bancontact - bancontact
                        * thai_qr - Payments made via Thai QR.
                        * go_pay - Payments made via GoPay
                        * wero - Payments made via Wero.
                        * pay_by_bank - Pay By Bank
                        * touch_n_go - Payments made via Touch 'n Go.
                        * google_pay - google_pay
                        * apple_pay - apple_pay
                        * qpay - Payments made via Qpay.
                        * online_banking_poland - Online Banking Poland
                        * trustly - Trustly
                        * gcash - Payments made via GCash.
                        * naver_pay - Payments made via Naver Pay.
                        * nupay - Payments made via NuPay.
                        * stablecoin - Payments made via Stablecoin.
                        * giropay - giropay
                        * paypal_express_checkout - paypal_express_checkout
                        * pix - Pix
                        * venmo - Venmo
                        * klarna_pay_now - Klarna Pay Now
                        * momo - Payments made via MoMo.
                        * alipay - Payments made via Alipay.
                        * sofort - sofort
                        * amazon_payments - Amazon Payments
                        * affirm_pay - Payments made via Affirm Pay.
                        * tamara - Payments made via Tamara.
                        * ideal - ideal
                        * kakao_pay - Payments made via Kakao Pay.
                        * picpay - Payments made via PicPay.
                        * fpx - Payments made via FPX.
                        * blik - Payments made via BLIK.
                        * pay_to - PayTo
                        * ovo - Payments made via OVO.
                        * dana - Payments made via Dana.
                        * south_korean_cards - Payments made via South Korean Cards
                        * 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.
                        * rakuten_pay - Payments made via Rakuten 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
                      - alipay_hk
                      - paypay
                      - gcash
                      - south_korean_cards
                      - paynow
                      - bizum
                      - promptpay
                      - dana
                      - touch_n_go
                      - tamara
                      - qpay
                      - ovo
                      - momo
                      - mercado_pago
                      - nequi
                      - nupay
                      - picpay
                      - thai_qr
                      - blik
                      - fpx
                      - wero
                      - p24
                      - affirm_pay
                      - rakuten_pay
                      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: |
                        Applicable only for Braintree gateway. Can be used only for Braintree's [Premium Fraud Management Tools](https://developer.paypal.com/braintree/articles/guides/fraud-tools/premium/overview).
                        Pass a stringified JSON containing the `device_session_id`
                        and `fraud_merchant_id`
                        as an input to `fingerprint`.
                        Here's a [sample](/docs/api/payment_parameters)
                        to it.
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |
                        * `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal).

                          * `payer`: User related information.
                            * `country_of_residence`: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a [two-character ISO code](https://docs.checkout.com/resources/codes/country-codes).
                            * `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
                        * `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
                        * `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user's `device_session_id` can be added to perform [additional validation](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                            * `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
                        * `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
                        * `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                        * `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.

                          * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
                        * `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.

                          * `payer`: User related information.
                            * `document`: Document is the user's identification number based on their country.
                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device
                      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: |
                      Resource object representing customer
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: |
                      Resource object representing payment_source
                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:
      tags:
      - payment_sources
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: |
                      Resource object representing payment_source
                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:
      tags:
      - payment_sources
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
                brand_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [brand](/docs/api/brands) this\
                    \ payment source should be linked to. Applicable only when multiple\
                    \ brands have been created for the site. This need not match the\
                    \ brand of the `customer_id`; when the two differ, the value provided\
                    \ here is used for the payment source. An alternative way of passing\
                    \ this parameter is by means of the `chargebee-brand-id` custom\
                    \ HTTP header; when both are provided, they must specify the same\
                    \ brand.  \n**Default behavior**\n\n* When not provided, the payment\
                    \ source is linked to the brand of the customer it is created\
                    \ for.\n"
                  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: |
                        The billing address of the customer. The value is a JSON object with the following keys and their values:- `first_name`:(string, max chars=150) The first name of the contact.

                        * `last_name`:(string, max chars=150) The last name of the contact.
                        * `line1`:(string, max chars=180) The first line of the address.
                        * `line2`:(string, max chars=180) The second line of the address.
                        * `country_code`:(string, max chars=50) The two-letter, [ISO 3166 alpha-2](https://www.iso.org/iso-3166-country-codes.html) country code for the address.
                        * `state_code`:(string, max chars=50) The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code/) without the country prefix.For instance, for Arizona (USA), set state_code as `AZ` (not `US-AZ`). For Tamil Nadu (India), set as `TN` (not `IN-TN`). For British Columbia (Canada), set as `BC` (not `CA-BC)`.
                        * `city`:(string, max chars=50) The city name for the address.
                        * `postal_code`:(string, max chars=20) The postal or ZIP code for the address.
                        * `phone`:(string, max chars=50) The contact phone number for the address.
                        * `email`:(string, max chars=70) The contact email address for the address.
                      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: |
                      Resource object representing customer
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: |
                      Resource object representing payment_source
                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:
      tags:
      - payment_sources
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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\n* direct_debit - Represents\
                    \ bank account for which the direct debit or ACH agreement/mandate\
                    \ is created.\n* touch_n_go - Payments made via Touch 'n Go.\n\
                    * unionpay - Payments made via UnionPay.\n* ovo - Payments made\
                    \ via OVO.\n* after_pay - Payments made via Afterpay\n* faster_payments\
                    \ - Payments made via Faster Payments\n* google_pay - Payments\
                    \ made via Google Pay.\n* alipay_hk - Payments made via Alipay\
                    \ HK.\n* momo - Payments made via MoMo.\n* mercado_pago - Payments\
                    \ made via Mercado Pago.\n* sepa_instant_transfer - Payments made\
                    \ via Sepa Instant Transfer\n* fpx - Payments made via FPX.\n\
                    * dotpay - Payments made via Dotpay.\n* pay_to - Payments made\
                    \ via PayTo\n* klarna - Payments made via Klarna.\n* revolut_pay\
                    \ - Payments made via Revolut Pay.\n* thai_qr - Payments made\
                    \ via Thai QR.\n* naver_pay - Payments made via Naver Pay.\n*\
                    \ paypay - Payments made via PayPay\n* generic - Payments made\
                    \ via Generic Payment Method.\n* payme - Payments made via PayMe\n\
                    * giropay - Payments made via giropay.\n* tamara - Payments made\
                    \ via Tamara.\n* klarna_pay_now - Payments made via Klarna Pay\
                    \ Now\n* grab_pay - Payments made via GrabPay\n* rakuten_pay -\
                    \ Payments made via Rakuten Pay.\n* twint - Payments made via\
                    \ Twint\n* swish - Payments made via Swish\n* automated_bank_transfer\
                    \ - Represents virtual bank account using which the payment will\
                    \ be done.\n* blik - Payments made via BLIK.\n* stablecoin - Payments\
                    \ made via Stablecoin.\n* paypal_express_checkout - Payments made\
                    \ via PayPal Express Checkout.\n* alipay -\n  Payments made via\
                    \ Alipay.  \n  This payment source is deprecated.\n* venmo - Payments\
                    \ made via Venmo\n* kakao_pay - Payments made via Kakao Pay.\n\
                    * sofort - Payments made via Sofort.\n* gcash - Payments made\
                    \ via GCash.\n* dana - Payments made via Dana.\n* pix - Payments\
                    \ made via Pix\n* p24 - Payments made via Przelewy24 (P24).\n\
                    * pay_co - Payments made via PayCo\n* wechat_pay -\n  Payments\
                    \ made via WeChat Pay.  \n  This payment source is deprecated.\n\
                    * ideal - Payments made via iDEAL.\n* trustly - Trustly\n* netbanking_emandates\
                    \ - Netbanking (eMandates) Payments.\n* upi - UPI Payments.\n\
                    * nupay - Payments made via NuPay.\n* picpay - Payments made via\
                    \ PicPay.\n* bancontact - Payments made via Bancontact Card.\n\
                    * go_pay - Payments made via GoPay\n* nequi - Payments made via\
                    \ Nequi.\n* wero - Payments made via Wero.\n* kbc_payment_button\
                    \ - KBC Payment Button\n* card - Card based payment including\
                    \ credit cards and debit cards. Details about the card can be\
                    \ obtained from the card resource.\n* cash_app_pay - Payments\
                    \ made via Cash App Pay.\n* payconiq_by_bancontact - Payments\
                    \ made via Payconiq by Bancontact.\n* amazon_payments - Payments\
                    \ made via Amazon Payments.\n* south_korean_cards - Payments made\
                    \ via South Korean Cards\n* pay_by_bank - Pay By Bank\n* online_banking_poland\
                    \ - Payments made via Online Banking Poland\n* qpay - Payments\
                    \ made via Qpay.\n* affirm_pay - Payments made via Affirm Pay.\n\
                    * apple_pay - Payments made via Apple Pay.\n* electronic_payment_standard\
                    \ - Electronic 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
                  - alipay_hk
                  - paypay
                  - gcash
                  - south_korean_cards
                  - paynow
                  - bizum
                  - promptpay
                  - dana
                  - touch_n_go
                  - tamara
                  - qpay
                  - ovo
                  - momo
                  - mercado_pago
                  - nequi
                  - nupay
                  - picpay
                  - thai_qr
                  - blik
                  - fpx
                  - wero
                  - p24
                  - affirm_pay
                  - rakuten_pay
                  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
                brand_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [brand](/docs/api/brands) this\
                    \ payment source should be linked to. Applicable only when multiple\
                    \ brands have been created for the site. This need not match the\
                    \ brand of the `customer_id`; when the two differ, the value provided\
                    \ here is used for the payment source. An alternative way of passing\
                    \ this parameter is by means of the `chargebee-brand-id` custom\
                    \ HTTP header; when both are provided, they must specify the same\
                    \ brand.  \n**Default behavior**\n\n* When not provided, the payment\
                    \ source is linked to the brand of the customer it is created\
                    \ for.\n"
                  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: |
                    * `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://docs.checkout.com/payment-methods/cards/dlocal).

                      * `payer`: User related information.
                        * `country_of_residence`: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a [two-character ISO code](https://docs.checkout.com/resources/codes/country-codes).
                        * `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
                    * `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.

                      * `fraud`: Fraud identification related information.
                        * `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
                    * `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user's `device_session_id` can be added to perform [additional validation](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.

                      * `fraud`: Fraud identification related information.
                        * `device_session_id`: Session ID associated with the user's device.
                        * `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
                    * `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.

                      * `fraud`: Fraud identification related information.
                        * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
                    * `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.

                      * `fraud`: Fraud identification related information.
                        * `device_session_id`: Session ID associated with the user's device.
                    * `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.

                      * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
                    * `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.

                      * `payer`: User related information.
                        * `document`: Document is the user's identification number based on their country.
                      * `fraud`: Fraud identification related information.
                        * `device_session_id`: Session ID associated with the user's device .
                  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: |
                      Resource object representing customer
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: |
                      Resource object representing payment_source
                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:
      tags:
      - payment_sources
      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/2.0/stripe.html)\n\
        , [Braintree](https://www.chargebee.com/docs/2.0/braintree.html)\n, [Authorize.net](https://www.chargebee.com/docs/2.0/authorize-index.html)\n\
        , [Worldpay US eCom](https://www.chargebee.com/docs/2.0/vantiv_worldpay.html)\n\
        , and [WorldPay Direct Integration](https://www.chargebee.com/docs/2.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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `billing_state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      maxLength: 50
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |
                        * `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries.

                          * `payer`: User related information.
                            * `document`: Document is the user's identification number based on their country.
                      example: null
                  example: null
                network_transaction_reference:
                  type: object
                  deprecated: false
                  properties:
                    original_network_transaction_id:
                      type: string
                      deprecated: false
                      maxLength: 100
                      example: null
                  example: null
              example: null
            encoding:
              card:
                style: deepObject
                explode: true
              network_transaction_reference:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: |
                      Resource object representing customer
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: |
                      Resource object representing payment_source
                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:
      tags:
      - payment_sources
      summary: Switch gateway account
      description: "Moves a card payment source from one gateway account to another.\n\
        \nUse this operation to migrate payment methods between gateway accounts,\
        \ such as when:\n\n* consolidating gateway accounts\n* switching from Spreedly\
        \ to direct gateway integration\n* aligning payment sources with regional/business\
        \ unit gateway configurations\n\n#### Supported gateways\n\nSee the **Use\
        \ Cases** section for the list of supported source-destination gateway combinations.\
        \  \n\n#### Impact on `reference_id`\n\nThis operation updates the [`reference_id`](/docs/api/payment_sources/payment_source-object#reference_id)\
        \ attribute of the payment source. In case you are using this value for any\
        \ downstream system integrations, you will need to update the `reference_id`\
        \ for the payment source in the downstream system to the new value.  \n\n\
        ### Prerequisites \\& Constraints\n\n* The [`payment_source.type`](/docs/api/payment_sources/payment_source-object#type)\
        \ must be `card`.\n* The destination payment gateway account must be active\
        \ and not [archived](https://www.chargebee.com/docs/payments/2.0/kb/billing/archiving-gateways).\
        \  \n\n### Impacts\n\n**Payment source**  \n* The following attributes are\
        \ updated:\n* [`gateway_account_id`](/docs/api/payment_sources/payment_source-object#gateway_account_id)\n\
        * [`gateway`](/docs/api/payment_sources/payment_source-object#gateway)\n*\
        \ [`reference_id`](/docs/api/payment_sources/payment_source-object#reference_id)\n\
        * The role ([primary](/docs/api/customers/customer-object#primary_payment_source_id)\
        \ or [backup](/docs/api/customers/customer-object#backup_payment_source_id))\
        \ of the payment source is not changed.  \n\n### Use Cases\n\n#### Supported\
        \ source-destination gateway combinations\n\nThe API supports only the following\
        \ source-destination gateway combinations:  \n\n|                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                  Source                                                \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                   |    \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                  Destination                           \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \           |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n\
        | Any of the gateways via Spreedly. These include [Authorize.net](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/authorize),\
        \ [Bambora](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/bambora),\
        \ [BlueSnap](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/bluesnap-spreedly),\
        \ [Moneris](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/moneris),\
        \ [Orbital (Chase Paymentech)](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/orbital),\
        \ [Paymill](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/paymill),\
        \ [PayPal Payments Pro](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/paypal_payments_pro),\
        \ [PayPal Payflow Pro](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/paypal_payflow_pro),\
        \ [SagePay](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/sagepay),\
        \ [Worldline Online Payments](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/ingenico),\
        \ [Worldpay](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/worldpay).\
        \ | * Any of the gateways via Spreedly. OR * Any of the following gateways:\
        \ [Stripe](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/stripe),\
        \ [Authorize.net (direct integration)](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/authorize-direct),\
        \ [Braintree](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/braintree),\
        \ [BlueSnap (direct integration)](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/bluesnap),\
        \ and [Worldpay (direct integration)](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/worldpay-direct).\
        \ |\n| [PayPal Express Checkout](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/paypal_express_checkout)\
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                 | [PayPal Commerce](https://www.chargebee.com/docs/payments/1.0/payment-gateways-and-configuration/paypal-commerce)\
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                             |\n\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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing customer
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: |
                      Resource object representing payment_source
                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:
      tags:
      - payment_sources
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
                brand_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [brand](/docs/api/brands) this\
                    \ payment source should be linked to. Applicable only when multiple\
                    \ brands have been created for the site. This need not match the\
                    \ brand of the `customer_id`; when the two differ, the value provided\
                    \ here is used for the payment source. An alternative way of passing\
                    \ this parameter is by means of the `chargebee-brand-id` custom\
                    \ HTTP header; when both are provided, they must specify the same\
                    \ brand.  \n**Default behavior**\n\n* When not provided, the payment\
                    \ source is linked to the brand of the customer it is created\
                    \ for.\n"
                  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: |
                      Resource object representing customer
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: |
                      Resource object representing payment_source
                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:
      tags:
      - payment_sources
      summary: Local delete a payment source
      description: "Delete a **payment source** reference from a Chargebee customer\
        \ without deleting or altering payment source data stored at the payment gateway.\
        \  \n\n### Impacts\n\n**Payment Source**  \nSets `deleted` = `true` on the\
        \ specified `payment_source` and detaches it from the customer. The payment\
        \ source is no longer accessible through the API or the UI.  \n**Customer**\
        \  \nIf the deleted `payment_source` is the customer's only payment method\
        \ and [`auto_collection`](/docs/api/customers/customer-object#auto_collection)\
        \ is `on`, [automatic payment collection](https://www.chargebee.com/docs/billing/2.0/customers/customers#auto-collection-status)\
        \ for future invoices fails.\n\nIf the deleted payment source was the [primary](/docs/api/customers/customer-object#primary_payment_source_id)\
        \ payment method for the customer, and a [backup](/docs/api/customers/customer-object#backup_payment_source_id)\
        \ exists, Chargebee promotes the backup to primary.\n\nIf no backup is set\
        \ but other `payment_source` objects exist for the [customer](/docs/api/payment_sources/payment_source-object#customer_id),\
        \ Chargebee promotes one of them to primary.  \n**Subscription**  \nWhen you\
        \ delete a payment source [linked](/docs/api/subscriptions/subscription-object#payment_source_id)\
        \ to an active [subscription](/docs/api/subscriptions), Chargebee immediately\
        \ clears the `payment_source_id` on that subscription. Future charges use\
        \ the customer's `primary_payment_source_id`.  \n\n#### Related APIs\n\n[Delete\
        \ a payment source](/docs/api/payment_sources?prod_cat_ver=2#delete_a_payment_source)[List\
        \ payment sources](/docs/api/payment_sources?prod_cat_ver=2#list_payment_sources)\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing customer
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: |
                      Resource object representing payment_source
                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:
      tags:
      - payment_sources
      summary: Create a bank account payment source
      description: "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.\n\n#### [Automated Clearing House (ACH) Network](https://www.chargebee.com/docs/direct-debit-payments.html#direct-debit-payments-in-the-united-states)\n\
        \nACH is an electronic network for passing financial transactions in the US.\
        \ Chargebee currently supports ACH via [Stripe](https://www.chargebee.com/docs/ach-payments-stripe.html)\
        \ , [Authorize.Net](https://www.chargebee.com/docs/ach-payments-authorize_net.html),\
        \ and [GoCardless](https://www.chargebee.com/docs/2.0/gocardless.html).  \n\
        **Note:**\n\n* For ACH via Stripe, it is mandatory to pass [user details](/docs/api/advanced-features)\
        \ such as IP address(`chargebee-request-origin-ip`) and the device information(`chargebee-request-origin-device`).\n\
        \n##### Bank account verification\n\nOnce the bank account has been added,\
        \ it needs to be verified.\n\n* For Stripe, perform this verification using\
        \ the [Verify bank account payment source API](/docs/api/payment_sources/verify-bank-account-payment-source).\n\
        * For [Authorize.net](https://www.authorize.net/), 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.\n\n#### Single Euro Payment Area (SEPA)\n\
        \nSEPA is an initiative that integrates bank transfer payments denominated\
        \ in euro. It is supported via [GoCardless](https://www.chargebee.com/docs/gocardless.html),\
        \ [Stripe](https://www.chargebee.com/docs/sepa-stripe.html) and [Adyen](https://www.chargebee.com/docs/adyen-sepa.html).\
        \  \n**Note:**\n\n* For SEPA via Stripe, it is mandatory to pass [user details](/docs/api/advanced-features)\
        \ such as IP address and device information.\n* For GoCardless, [local bank\
        \ details](https://developer.gocardless.com/api-reference/#appendix-local-bank-details)\
        \ can be passed instead of IBAN.\n\n#### Bacs Payment Schemes Limited (BACS)\
        \ and Bg Autogiro\n\nBacs 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 [GoCardless](https://www.chargebee.com/docs/gocardless.html).\
        \  \n**Note:**\n\n* For BACS via Stripe, it is mandatory to pass [user details](/docs/api/advanced-features)\
        \ such as IP address(`chargebee-request-origin-ip`) and the device information(`chargebee-request-origin-device`).\n\
        \n#### Bulk Electronic Clearing System (BECS) and Pre-Authorized Debit (PAD)\n\
        \nBECS is an automated payment method for Direct Debit in Australia and New\
        \ Zealand while PAD does the same for Canada. [GoCardless](https://www.chargebee.com/docs/gocardless.html)\
        \ supports both.\n\nFor 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 [Retrieve direct debit agreement PDF API](/docs/api/hosted_pages/retrieve-direct-debit-agreement-pdf).\n\
        \nIf the customer has already reached the payment source limit allowed for\
        \ the site, pass `replace_primary_payment_source` as `true`. Alternatively,\
        \ [delete](/docs/api/payment_sources/delete-a-payment-source) one of the payment\
        \ sources first and then add the bank account payment source for the customer.\
        \  \n**Note:**\n\n* For BECS via Stripe, it is mandatory to pass [user details](/docs/api/advanced-features)\
        \ such as IP address(`chargebee-request-origin-ip`) and the device information(`chargebee-request-origin-device`).\n"
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
                brand_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [brand](/docs/api/brands) this\
                    \ payment source should be linked to. Applicable only when multiple\
                    \ brands have been created for the site. This need not match the\
                    \ brand of the `customer_id`; when the two differ, the value provided\
                    \ here is used for the payment source. An alternative way of passing\
                    \ this parameter is by means of the `chargebee-brand-id` custom\
                    \ HTTP header; when both are provided, they must specify the same\
                    \ brand.  \n**Default behavior**\n\n* When not provided, the payment\
                    \ source is linked to the brand of the customer it is created\
                    \ for.\n"
                  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: |
                        The billing address associated with the bank account. The value is a JSON object with the following keys and their values:- `first_name`:(string, max chars=150) The first name of the contact.

                        * `last_name`:(string, max chars=150) The last name of the contact.
                        * `company_name`:(string, max chars=250) The company name for the address.
                        * `line1`:(string, max chars=180) The first line of the address.
                        * `line2`:(string, max chars=180) The second line of the address.
                        * `country`:(string) The name of the country for the address.
                        * `country_code`:(string, max chars=50) The two-letter, [ISO 3166 alpha-2](https://www.iso.org/iso-3166-country-codes.html) country code for the address.
                        * `state`:(string, max chars=50) The name of the state or province for the address. When not provided, this is set automatically for US, Canada, India, and UAE.
                        * `state_code`:(string, max chars=50) The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code/) without the country prefix. This is supported for USA, Canada, India, and UAE. For instance, for Arizona (USA), set state_code as `AZ` (not `US-AZ`). For Tamil Nadu (India), set as `TN` (not `IN-TN`). For British Columbia (Canada), set as `BC` (not `CA-BC`). For Dubai (UAE), set as `DU` (not `AE-DU`).
                        * `city`:(string, max chars=50) The city name for the address.
                        * `postal_code`:(string, max chars=20) The postal or ZIP code for the address.
                        * `phone`:(string, max chars=50) The contact phone number for the address.
                        * `email`:(string, max chars=70) The contact email address for the address.
                      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: |
                      Resource object representing customer
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: |
                      Resource object representing payment_source
                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:
      tags:
      - payment_sources
      summary: Update a bank account payment source
      description: |
        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.

        * For GoCardless, Chargebee supports (ACH,BACS,SEPA,AUTOGIRO,BECS,BECS_NZ,PAD).
        * For Stripe, Chargebee only supports SEPA.

        The API is only supported for the `payment_method` of type `direct_debit`.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing customer
                  payment_source:
                    $ref: "#/components/schemas/PaymentSource"
                    description: |
                      Resource object representing payment_source
                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: []
  /vaulted_payment_methods/{vaulted-payment-method-id}:
    get:
      tags:
      - vaulted_payment_methods
      summary: Retrieve vaulted payment method
      operationId: retrieve_vaulted_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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: vaulted-payment-method-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/vaulted-payment-method-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  vaulted_payment_method:
                    $ref: "#/components/schemas/VaultedPaymentMethod"
                    description: Resource object representing vaulted_payment_method
                required:
                - vaulted_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: []
  /virtual_bank_accounts/{virtual-bank-account-id}/delete_local:
    post:
      tags:
      - virtual_bank_accounts
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing virtual_bank_account
                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:
      tags:
      - virtual_bank_accounts
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing virtual_bank_account
                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:
      tags:
      - virtual_bank_accounts
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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:
      tags:
      - virtual_bank_accounts
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: "Identifier of the gateway account to use when creating\
                    \ the virtual bank account.  \n**Default behavior**\nWhen not\
                    \ provided, Chargebee selects an applicable gateway account for\
                    \ the chosen `scheme`. Selection follows your site's [Smart Routing](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/gateway_settings#smart-routing)\
                    \ rules.\n"
                  maxLength: 50
                  example: null
                scheme:
                  type: string
                  default: ach_credit
                  deprecated: false
                  description: "Type of the credit transfer.\n\n* mx_automated_bank_transfer\
                    \ - MX Automated Bank Transfer\n* sepa_credit -\n  SEPA Credit\
                    \ Transfer  \n  This scheme is deprecated. Instead of `sepa_credit`\n\
                    \  use `eu_automated_bank_transfer`\n  .\n* eu_automated_bank_transfer\
                    \ - EU Automated Bank Transfer\n* ach_credit -\n  ACH Credit Transfer\
                    \  \n  This scheme is deprecated. Instead of `ach_credit`\n  use\
                    \ `us_automated_bank_transfer`\n  .\n* jp_automated_bank_transfer\
                    \ - JP Automated Bank Transfer\n* us_automated_bank_transfer -\
                    \ US Automated Bank Transfer\n* gb_automated_bank_transfer - UK\
                    \ Automated Bank Transfer\n"
                  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: |
                      Resource object representing virtual_bank_account
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: |
                      Resource object representing customer
                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:
      tags:
      - virtual_bank_accounts
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing virtual_bank_account
                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:
      tags:
      - virtual_bank_accounts
      summary: Create a virtual bank account using permanent token
      description: "Creates a virtual bank account (VBA) for a [customer](/docs/api/customers)\
        \ using a [permanent token](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/stripe-automated-bank-transfer#supported-token-formats)\
        \ obtained from a payment gateway.\n\nUse this operation when you have already\
        \ created a payment source at the gateway and obtained a permanent token (reference\
        \ ID) for it.  \n\n### Prerequisites \\& Constraints\n\n* The customer must\
        \ not already have an active VBA for the same [`scheme`](/docs/api/virtual_bank_accounts#scheme).\
        \ For example, if the customer already has a VBA with `scheme` set to `us_automated_bank_transfer`,\
        \ you cannot create another VBA with the same scheme.  \n\n### Impacts\n\n\
        **Virtual bank account**  \n* A new virtual bank account resource is created\
        \ and associated with the customer. The virtual bank account includes details\
        \ such as bank account number, routing number (or IBAN), bank name, and other\
        \ payment instructions retrieved from the gateway using the provided reference\
        \ ID.\n* The [email address](/docs/api/virtual_bank_accounts#email) for the\
        \ VBA is set at the gateway from the [`customer.email`](/docs/api/customers#email)\
        \ attribute. Later, if the email address is updated for the customer, the\
        \ email address for the VBA is also updated.  \n\n### Implementation Notes\n\
        \n* Check if the customer already has a virtual bank account for the same\
        \ scheme by calling the [List virtual bank accounts API](/docs/api/virtual_bank_accounts/list-virtual-bank-accounts)\
        \ with the [customer ID](/docs/api/customers/list-customers#list_customers_id)\
        \ filter. If a virtual bank account exists for the same scheme, the API returns\
        \ a `payment_method_already_exists` error.\n\n* Validate that the required\
        \ currency for the scheme is enabled. Use the [List currencies API](/docs/api/currencies/list-currencies)\
        \ to check if the currency is enabled.\n\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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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](/docs/api/customers) for whom you want to create a virtual bank account.
                  maxLength: 50
                  example: null
                reference_id:
                  type: string
                  deprecated: false
                  description: "The identifier (permanent token) used to fetch the\
                    \ payment source details from the gateway. For example, in Stripe\
                    \ it may be only the Stripe Customer ID (for example, cus_63MnDn0t6kfDW7),\
                    \ or a combination of Stripe Customer ID and Stripe Source ID\
                    \ separated by a forward slash (for example, cus_63MnDn0t6kfDW7/src_6WjCF20vT9WN1G).\
                    \  \n**Constraints**\n\n* If `gateway_account_id` is provided,\
                    \ the `reference_id` must belong to the gateway account.\n* If\
                    \ the `gateway_account_id` is not provided, the `reference_id`\
                    \ must belong to the gateway account selected based on the [gateway\
                    \ routing rules](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/gateway_settings#smart-routing)\
                    \ for the payment method type and currency combination.\n"
                  maxLength: 150
                  example: null
                gateway_account_id:
                  type: string
                  deprecated: false
                  description: "Identifier of the payment gateway account to use when\
                    \ creating the virtual bank account.  \n**Default behavior**\n\
                    When not provided, Chargebee selects an applicable gateway account\
                    \ for the chosen `scheme`. Selection follows your site's [Smart\
                    \ Routing](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/gateway_settings#smart-routing)\
                    \ rules.\n"
                  maxLength: 50
                  example: null
                scheme:
                  type: string
                  default: ach_credit
                  deprecated: false
                  description: "The type of automated bank transfer scheme for the\
                    \ virtual bank account.  \n**Prerequisites**\n\n* If billing address\
                    \ validation is enabled for your site, the customer must have\
                    \ a billing address with a country code.\n\n* mx_automated_bank_transfer\
                    \ -\n  Mexico Automated Bank Transfer scheme for Mexico-based\
                    \ customers.  \n  **Prerequisites**\n\n  * MXN currency must be\
                    \ [enabled](https://www.chargebee.com/docs/billing/2.0/site-configuration/multi-currency-pricing)\
                    \ for the site.\n  * The customer's [`billing_address.country`](/docs/api/customers#billing_address_country)\
                    \ must be `MX`.\n* sepa_credit -\n  **Deprecated**\n\n  * This\
                    \ scheme is deprecated. Use `eu_automated_bank_transfer` instead.\n\
                    \n  SEPA Credit Transfer scheme for customers in the European\
                    \ Union.\n* eu_automated_bank_transfer -\n  EU Automated Bank\
                    \ Transfer scheme for customers in the European Union.  \n  **Prerequisites**\n\
                    \n  * EUR currency must be [enabled](https://www.chargebee.com/docs/billing/2.0/site-configuration/multi-currency-pricing)\
                    \ for the site.\n  * The customer's [`billing_address.country`](/docs/api/customers#billing_address_country)\
                    \ must be in a SEPA-supported region.\n* ach_credit -\n  **Deprecated**\n\
                    \n  * This scheme is deprecated. Use `us_automated_bank_transfer`\
                    \ instead.\n\n  ACH Credit Transfer scheme for US-based customers.\n\
                    * jp_automated_bank_transfer -\n  Japan Automated Bank Transfer\
                    \ scheme for Japan-based customers.  \n  **Prerequisites**\n\n\
                    \  * JPY currency must be [enabled](https://www.chargebee.com/docs/billing/2.0/site-configuration/multi-currency-pricing)\
                    \ for the site.\n  * The customer's [`billing_address.country`](/docs/api/customers#billing_address_country)\
                    \ must be `JP`.\n* us_automated_bank_transfer -\n  US Automated\
                    \ Bank Transfer scheme for US-based customers.  \n  **Prerequisites**\n\
                    \n  * USD currency must be [enabled](https://www.chargebee.com/docs/billing/2.0/site-configuration/multi-currency-pricing)\
                    \ for the site.\n  * The customer's [`billing_address.country`](/docs/api/customers#billing_address_country)\
                    \ must be `US`.\n\n  US Automated Bank Transfer\n* gb_automated_bank_transfer\
                    \ -\n  UK Automated Bank Transfer scheme for UK-based customers.\
                    \  \n  **Prerequisites**\n\n  * GBP currency must be [enabled](https://www.chargebee.com/docs/billing/2.0/site-configuration/multi-currency-pricing)\
                    \ for the site.\n  * The customer's [`billing_address.country`](/docs/api/customers#billing_address_country)\
                    \ must be `GB`.\n"
                  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: |
                      Resource object representing virtual_bank_account
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: |
                      Resource object representing customer
                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:
      tags:
      - customers
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing third_party_payment_method
                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:
      tags:
      - cards
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
                  card:
                    $ref: "#/components/schemas/Card"
                    description: |
                      Resource object representing card
                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:
      tags:
      - customers
      summary: Switch gateway
      description: "#### Deprecated\n\nThis request is obsoleted by the [Switch gateway\
        \ account API](/docs/api/payment_sources/switch-gateway-account)\nfor Payment\
        \ Sources.\n\nSwitches the gateway in which customer's card information is\
        \ stored. This is applicable only if the payment method is `card`.  \n**Limitation**\n\
        \nThis request does not support switching 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: 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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing customer
                  card:
                    $ref: "#/components/schemas/Card"
                    description: |
                      Resource object representing card
                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:
      tags:
      - customers
      summary: Delete card for a customer
      description: |
        #### deprecated

        The [Payment Sources API](/docs/api/payment_sources)
        , with its additional options and improvements, obsoletes the Cards APIs. This request is obsoleted by the [Delete a payment source API](/docs/api/payment_sources/delete-a-payment-source)
        .

        Deletes the card for a customer. Upon successful deletion the `auto_collection` attribute for the customer is set to `off` and a `card_deleted` event is triggered. If there is no card found at the gateway for the customer, this API returns without errors.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing customer
                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:
      tags:
      - customers
      summary: Update card for a customer
      description: |
        #### Deprecated

        The [Payment Sources API](/docs/api/payment_sources)
        , with its additional options and improvements, obsoletes the [Cards APIs](/docs/api/cards)
        . This operation is obsoleted by the following:

        * [Create using temporary token](/docs/api/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)

        Adds or replaces card details of a customer. Updating card details replaces the present payment method.

        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

        * If you are using Stripe gateway, you can use [Stripe.js](https://stripe.com/docs/stripe.js) with your card update form.
        * If you are using Braintree gateway, you can use [Braintree.js](https://www.braintreepayments.com/docs/javascript) with your card update form.
        * If you are using Authorize.Net gateway, you use [Accept.js](https://developer.authorize.net/api/reference/features/acceptjs.html) with your card update form.
        * In case 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.
        * You can also use our [Hosted Pages](https://www.chargebee.com/docs/billing/2.0/hosted-capabilities/hosted-capabilities) based integration. Use our [Hosted Page - Update Card](/docs/api/hosted_pages) API to generate a 'Update Card' Hosted Page link.

        **Legacy behavior:**

        * **For [sites](https://www.chargebee.com/docs/sites-intro.html) created before March 1st, 2014:** On making this request, the `billing_address` and `vat_number` of the customer are **deleted** and replaced by the values passed with this request. Ensure that you pass the [billing address parameters](/docs/api/v2/pcv-1/subscriptions/create-a-subscription#card_billing_addr1) and the `vat_number` parameters each time you make this request, to avoid losing the same information at the customer-level.
        * **For [sites](https://www.chargebee.com/docs/sites-intro.html) created on or after March 1st, 2014:** This request does not alter the `billing_address` and `vat_number` of the customer.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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 supported\
                    \ only for Stripe, Adyen, and Chargebee Payments.\n\n* dankort\
                    \ - A Dankort card scheme. Supported only for Adyen and Chargebee\
                    \ Payments.\n* mastercard - A MasterCard scheme.\n* cartes_bancaires\
                    \ - A Cartes Bancaires card scheme.\n* visa - A Visa card scheme.\n"
                  enum:
                  - cartes_bancaires
                  - mastercard
                  - visa
                  - dankort
                  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: |
                    The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                    without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `billing_state_code`
                    as `AZ`
                    (not `US-AZ`
                    ). For Tamil Nadu (India), set as `TN`
                    (not `IN-TN`
                    ). For British Columbia (Canada), set as `BC`
                    (not `CA-BC`
                    ). For Dubai (UAE), set as `DU`
                    (not `AE-DU`
                    ).
                  maxLength: 50
                  example: null
                billing_state:
                  type: string
                  deprecated: false
                  description: |
                    The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `billing_state_code`
                    is provided.
                  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: "The billing address country of the customer. Must\
                    \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                    .\n\n**Note**:\nIf you enter an invalid country code, the system\
                    \ will return an error.  \n**Brexit**\n\nIf you have enabled [EU\
                    \ VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021 or\
                    \ later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                    \ the Brexit configuration, then `XI` (the code for **United Kingdom\
                    \ - Northern Ireland**) is available as an option.\n\n.\n"
                  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: |
                      Resource object representing customer
                  card:
                    $ref: "#/components/schemas/Card"
                    description: |
                      Resource object representing card
                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:
      tags:
      - promotional_credits
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - 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: |
                      Resource object representing promotional_credit
                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:
      tags:
      - promotional_credits
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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:
      tags:
      - promotional_credits
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing customer
                  promotional_credit:
                    $ref: "#/components/schemas/PromotionalCredit"
                    description: |
                      Resource object representing promotional_credit
                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:
      tags:
      - promotional_credits
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing customer
                  promotional_credit:
                    $ref: "#/components/schemas/PromotionalCredit"
                    description: |
                      Resource object representing promotional_credit
                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:
      tags:
      - promotional_credits
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing customer
                  promotional_credit:
                    $ref: "#/components/schemas/PromotionalCredit"
                    description: |
                      Resource object representing promotional_credit
                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: []
  /customers/{customer-id}/email_logs:
    get:
      tags:
      - customers
      summary: List email logs for a customer
      operationId: list_email_logs_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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
      - 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: sent_on
        in: query
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          description: |
            Filter by when the email was scheduled to be sent. Pass a Unix timestamp in seconds. Must be within the last 7 days. `between` and combined `after`/`before` can span at most 24 hours. `after` alone returns the following 24 hours; `before` alone returns the preceding 24 hours.
          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: business_entity_id
        in: query
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          description: Filter by business entity ID. Applicable only when Multi Business
            Entity is enabled.
          example: business_entity_id
          properties:
            is:
              type: string
              minLength: 1
              example: null
      - name: brand_id
        in: query
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          description: Filter by brand ID. Applicable only when Multi Brand is enabled.
          example: brand_id
          properties:
            is:
              type: string
              minLength: 1
              example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        email_log:
                          $ref: "#/components/schemas/EmailLog"
                          description: Resource object representing email_log
                      required:
                      - email_log
                      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}/delete_line_items:
    post:
      tags:
      - invoices
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing invoice
                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:
      tags:
      - invoices
      summary: Remove credit note from an invoice
      description: "Removes the specified adjustment credit or refundable credit allocation\
        \ applied to the invoice.  \n\n### Prerequisites \\& Constraints\n\n* The\
        \ invoice status must not be `voided` or `pending`.\n* The credit note status\
        \ must not be `voided`.\n* The credit note type must be `adjustment` or `refundable`.\n\
        * Refundable credit allocation cannot be removed if the amount allocated exceeds\
        \ the refundable amount on the invoice. See **Implementation Notes** for more\
        \ details.  \n\n### Impacts\n\n**Invoice**  \n* The [`amount_due`](/docs/api/invoices/invoice-object#amount_due)\
        \ increases by the [`allocations[i].allocated_amount`](/docs/api/credit_notes/credit-note-object#allocations)\
        \ of the credit note.\n* The [`amount_adjusted`](/docs/api/invoices/invoice-object#amount_adjusted)\
        \ decreases by the `allocations[i].allocated_amount` of the credit note if\
        \ the `credit_note.type` is `adjustment`.\n* The [`write_off_amount`](/docs/api/invoices/invoice-object#write_off_amount)\
        \ decreases by the `allocations[i].allocated_amount` of the credit note if\
        \ the `credit_note.create_reason_code` is `Write Off`.\n* If the invoice [status](/docs/api/invoices/invoice-object#status)\
        \ was `payment_due`, `not_paid`, or `posted`, the status does not change after\
        \ the credit note is removed.\n* If the invoice status was `paid`:\n  * The\
        \ status changes to `posted` if the [`due_date`](/docs/api/invoices/invoice-object#due_date)\
        \ is in the future.\n* The status changes to `not_paid` if the due date is\
        \ in the past.  \n**Credit note**  \n* The `amount_allocated` decreases and\
        \ the `amount_available` increases by the `allocations[i].allocated_amount`,\
        \ where `i` is such that `allocations[i].invoice_id` = `invoice.id`.  \n\n\
        ### Implementation Notes\n\nBefore you call this API, make sure that:\n\n\
        * The invoice status is not `voided` or `pending`.\n* The credit note status\
        \ is not `voided`.\n* The credit note type is `adjustment` or `refundable`.\n\
        * For refundable credit notes, the amount allocated to the invoice via the\
        \ credit note must not exceed the refundable amount on the invoice. The refundable\
        \ amount on the invoice is calculated as: (total amount paid) + (total refundable\
        \ credits allocated to the invoice) + (total tax withheld recorded on the\
        \ invoice) - (total refundable credits issued against the invoice). Each of\
        \ these amounts can be obtained as follows:\n  * amount allocated to the invoice\
        \ via the credit note: `credit_note.allocations[i].allocated_amount` where\
        \ `credit_note.allocations[i].invoice_id` == `invoice.id`.\n  * total amount\
        \ paid: `invoice.amount_paid`.\n  * total refundable credits allocated to\
        \ the invoice: sum of `invoice.applied_credits[i].applied_amount`\n  * total\
        \ tax withheld recorded on the invoice: sum of `invoice.linked_taxes_withheld[i].amount`\n\
        \  * total refundable credits issued against the invoice: sum of `invoice.issued_credit_notes[i].cn_total`\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing invoice
                  credit_note:
                    $ref: "#/components/schemas/CreditNote"
                    description: |
                      Resource object representing credit_note
                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:
      tags:
      - invoices
      summary: Remove payment from an invoice
      description: "Removes a [payment](/docs/api/invoices/apply-payments-for-an-invoice)\
        \ [transaction](/docs/api/invoices) that was applied to an invoice and moves\
        \ the amount to the customer's excess payments balance.\n\nThis API does not\
        \ refund the payment to the customer. To refund a payment transaction, use\
        \ one of the following APIs:\n\n* For online payments, use [Refund a payment](/docs/api/transactions/refund-a-payment).\n\
        * For offline payments, use [Record an offline refund](/docs/api/transactions/record-an-offline-refund).\
        \  \n\n### Prerequisites \\& Constraints\n\n* The invoice must not have any\
        \ refunds or refundable credits issued. Specifically, there must be no [`issued_credit_notes`](/docs/api/invoices/invoice-object#issued_credit_notes)\
        \ with a `cn_status` value of `refunded` or `refund_due` for the invoice.\n\
        * The specified transaction must be linked to the invoice. It must match one\
        \ of the [`linked_payments[].txn_id`](#invoice_linked_payments) for the invoice.\n\
        * The [`status`](/docs/api/transactions/transaction-object#status) of the\
        \ transaction must be `success`, `in_progress`, or `needs_attention`.  \n\n\
        ### Impacts\n\n**Invoice**  \n* The [`amount_due`](/docs/api/invoices/invoice-object#amount_due)\
        \ on the invoice increases by the amount of the removed payment.\n* If the\
        \ invoice [status](/docs/api/invoices/invoice-object#status) was `payment_due`,\
        \ `not_paid`, or `posted`, the status does not change after a payment is removed.\n\
        * If the invoice status was `paid`:\n  * The status changes to `posted` if\
        \ the [`due_date`](/docs/api/invoices/invoice-object#due_date) is in the future.\n\
        \  * The status changes to `payment_due` if the `due_date` is in the past\
        \ and [`auto_collection`](/docs/api/customers/customer-object#auto_collection)\
        \ is `off`, or if `auto_collection` is `on` and dunning is in progress for\
        \ the invoice.\n* The status changes to `not_paid` if the due date is in the\
        \ past, [`auto_collection`](/docs/api/customers/customer-object#auto_collection)\
        \ is `on`, and dunning was **not** in progress for the invoice.  \n**Transaction**\
        \  \nThe [`amount_unused`](/docs/api/transactions/transaction-object#amount_unused)\
        \ on the transaction increases by the amount of the removed payment.  \n**Customer\
        \ excess payments balance**  \nThe customer's [`excess_payments`](/docs/api/customers/customer-object#excess_payments)\
        \ balance increases by the amount of the removed payment.  \n**Invoice dunning\
        \ process**  \n* If the invoice status was `payment_due` before this operation,\
        \ and dunning was in progress for the invoice, the dunning process continues\
        \ as configured.\n* If the invoice status was `paid` before this operation,\
        \ the dunning process **does not** resume.  \n\n### Implementation Notes\n\
        \nBefore you call this API, make sure that:\n\n* There are no [`issued_credit_notes`](/docs/api/invoices/invoice-object#issued_credit_notes)\
        \ with a `cn_status` value of `refunded` or `refund_due` for the invoice.\n\
        * The specified transaction matches one of the [`linked_payments[].txn_id`](#invoice_linked_payments)\
        \ for the invoice.\n* The [`status`](/docs/api/transactions/transaction-object#status)\
        \ of the transaction is `success`, `in_progress`, or `needs_attention`.  \n\
        \n#### Related APIs\n\n[Refund a payment](/docs/api/transactions?prod_cat_ver=2#refund_a_payment)[Record\
        \ an offline refund](/docs/api/transactions?prod_cat_ver=2#record_an_offline_refund)\
        \  \n\n### FAQs\n\n#### Can I remove payments from multiple invoices at once?\n\
        \nYes. To remove payments from multiple invoices in bulk, go to **Settings**\
        \ \\> **Import** \\> **Export Data** \\> **Bulk Operation** , and select **Remove\
        \ payment from Invoice**.  \n\n#### How can I track the history of payments\
        \ removed from invoices?\n\nYou can view the history of payments removed from\
        \ invoices in the **Activity Log** section of the invoice. The log shows all\
        \ actions taken, including payments removed.\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing invoice
                  transaction:
                    $ref: "#/components/schemas/Transaction"
                    description: |
                      Resource object representing transaction
                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:
      tags:
      - invoices
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing invoice
                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:
      tags:
      - invoices
      summary: Apply payments for an invoice
      description: "Applies payment to a single invoice. You can either specify individual\
        \ payment [transactions](/docs/api/transactions) as parameters, or Chargebee\
        \ applies any available [excess payments](/docs/api/customers/customer-object#excess_payments)\
        \ for that customer. If you specify individual transactions then any [un-applied\
        \ amount](/docs/api/transactions/transaction-object#amount_unused) in those\
        \ transactions will be used.  \n\n### Prerequisites \\& Constraints\n\n* The\
        \ invoice's `status` must be `payment_due`, `posted`, or `not_paid`.\n* The\
        \ customer must have excess payments available.  \n\n### Impacts\n\n**Invoice**\
        \  \nInvoice's [`amount_due`](/docs/api/invoices/invoice-object#amount_due)\
        \ is updated to reflect the applied payment. If no amount remains, the invoice\
        \ `status` becomes `paid`.  \n**Transactions**  \nWhen a payment is applied\
        \ to an invoice, the [`amount_unused`](/docs/api/transactions/transaction-object#amount_unused)\
        \ field of the associated transaction(s) is reduced accordingly.  \n**Payment\
        \ Schedules**  \nIf a [`payment_schedule`](/docs/api/payment_schedules) exists\
        \ for the invoice:\n\n* Chargebee reduces [`schedule_entries[].amount`](/docs/api/payment_schedules/payment_schedule-object#schedule_entries)\
        \ for the entries the payment covers. An entry whose remaining amount reaches\
        \ `0` is marked `paid`.\n* Chargebee adds the payment to [`reference_transactions[]`](/docs/api/payment_schedules/payment_schedule-object#reference_transactions).\
        \  \n**Accounting Integrations**  \nSynchronization to the accounting system\
        \ will not proceed if the linked transaction contains a surplus balance. \
        \ \n\n### Implementation Notes\n\nBefore calling this API, ensure the following:\n\
        \n* The `invoice` status is `not_paid`, `payment_due`, or `posted`.\n* Customer\
        \ has [excess_payments](/docs/api/customers/customer-object#excess_payments)\
        \ .\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                        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, [transactions.unused_amount](/docs/api/invoices/invoice-object#amount_due)
                        , or [invoice.amount_due](/docs/api/invoices/invoice-object#amount_due)
                        .
                      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: |
                      Resource object representing invoice
                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_payment_schedule_scheme:
    post:
      tags:
      - invoices
      summary: Apply payment schedule scheme to an invoice
      description: "Applying a payment schedule scheme to an invoice creates payment\
        \ schedules, enabling the invoice to be paid in multiple, scheduled payments.\
        \  \n**Note:**\nThe invoice must be in `payment_due`\n.\n"
      operationId: apply_payment_schedule_scheme_to_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
                scheme_id:
                  type: string
                  deprecated: false
                  description: |
                    The identifier of the `payment_schedule_scheme`
                    , used to create the payment schedules.
                  example: null
                amount:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    The part of the `invoice.amount_due`
                    to be distributed across the payment schedules. If not specified, the entire `invoice.amount_due`
                    is considered by default.
                  minimum: 0
                  example: null
              required:
              - scheme_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: |
                      Resource object representing invoice
                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:
      tags:
      - invoices
      summary: Void an invoice
      description: "Voids the specified invoice.\n\nUse this operation when:\n\n*\
        \ The invoice was generated in error.\n* The invoice amount is incorrect.\n\
        * The customer requests a change to the invoice.\n* The customer cancels the\
        \ order.\n\nVoiding preserves the audit trail and allows for future reference\
        \ and compliance without removing the original record.\n\n#### Regenerate\
        \ or import an invoice\n\n* If the invoice is for the current term of a subscription,\
        \ you can regenerate it using the [Regenerate an invoice API](/docs/api/subscriptions/regenerate-an-invoice).\n\
        * If the invoice is not for the current term of a subscription, you can import\
        \ it using the [Import an invoice API](/docs/api/invoices/import-invoice)\
        \ or the UI [bulk import](https://www.chargebee.com/docs/2.0/bulk-operations.html#overview_available-bulk-operations)\
        \ action.  \n\n### Prerequisites \\& Constraints\n\n* The invoice `status`\
        \ must be `payment_due`, `posted`, or `not_paid`.\n* The invoice must not\
        \ have any [`linked_payments`](/docs/api/invoices/invoice-object#linked_payments)\
        \ with `txn_status` set to `success` or `in_progress`.\n* The `amount_adjusted`\
        \ on the invoice must be zero.\n* The invoice must not have any [`applied_credits`](/docs/api/invoices/invoice-object#applied_credits)\
        \ with `cn_status` set to `refunded` or `refund_due`.\n* The invoice must\
        \ not have any [`issued_credit_notes`](/docs/api/invoices/invoice-object#issued_credit_notes)\
        \ with `cn_status` set to `refunded` or `refund_due`.\n* The invoice must\
        \ not have any [`linked_taxes_withheld`](/docs/api/invoices/invoice-object#linked_taxes_withheld).\
        \  \n\n### Impacts\n\n**Invoices**  \n* Chargebee sets the invoice `status`\
        \ to `voided`.  \n**Subscription**  \n* If the invoice is for the current\
        \ term of a subscription and you change the subscription later within the\
        \ same term with [proration](/docs/api/subscriptions/update-subscription-for-items#prorate)\
        \ enabled, Chargebee does not issue prorated credits.  \n**Customer**  \n\
        * Chargebee adds back any promotional credits that were applied to the invoice\
        \ to [`customer.balances.promotional_credits`](/docs/api/customers/customer-object#balances).\
        \  \n**Credit Note**  \n* If the [**Void invoices with credit note**](https://www.chargebee.com/docs/billing/2.0/kb/billing/how-to-enable-void-invoice-with-credit-note-setting)\
        \ setting is enabled, Chargebee creates a credit note for the voided invoice:\n\
        \  * The credit note `type` is `adjustment`.\n  * The credit note `status`\
        \ is `adjusted`.\n* The credit note `create_reason_code` is `Invoice Void`.\
        \  \n**Usages**  \n* Chargebee delinks the [`usage`](/docs/api/usages) resources\
        \ associated with the invoice by clearing the `invoice_id` attribute.  \n\
        **Integrations**  \n* Review how voiding an invoice impacts your [accounting](https://www.chargebee.com/docs/billing/2.0/integrations/finance-integration-index)\
        \ integrations.  \n\n### Implementation Notes\n\nBefore calling this API,\
        \ ensure the following:\n\n* The invoice `status` is `payment_due`, `posted`,\
        \ or `not_paid`.\n* [Remove](/docs/api/invoices/remove-payment-from-an-invoice)\
        \ any `linked_payments` with `txn_status` set to `success` or `in_progress`.\n\
        * [Remove](/docs/api/invoices/remove-credit-note-from-an-invoice) the following\
        \ credits:\n  * any `applied_credits` with `cn_status` set to `refunded` or\
        \ `refund_due`\n  * any `issued_credit_notes` with `cn_status` set to `refunded`\
        \ or `refund_due`\n  * any `adjustment_credit_notes` with `cn_status` set\
        \ to `adjusted`\n* [Remove](/docs/api/invoices/remove-tax-withheld-for-an-invoice)\
        \ any `linked_taxes_withheld`.\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing invoice
                  credit_note:
                    $ref: "#/components/schemas/CreditNote"
                    description: |
                      Resource object representing credit_note
                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:
      tags:
      - invoices
      summary: Add one-time charge to a pending invoice
      description: |
        Adds a one-time charge to a [pending](/docs/api/invoices/invoice-object#status) invoice. A one-time charge is a charge that is added ad hoc to the invoice and does not represent a predefined [item price](/docs/api/item_prices). It appears in the invoice as a [line_item](/docs/api/invoices/invoice-object#line_items) of [entity_type](/docs/api/invoices/invoice-object#line_items_entity_type) `adhoc`.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing invoice
                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:
      tags:
      - invoices
      summary: Send an einvoice for invoices
      description: |+
        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:

        * If e-invoicing is not enabled at the site and customer level.

        * If there is an e-invoice generated already for the invoice.

        * If the **Use automatic e-invoicing** option is selected.

        * If there are no generated e-invoices with the `failed` or `skipped` status.

        * If the invoice status is `voided` or `pending`.

      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing invoice
                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}/payment_schedules:
    get:
      tags:
      - invoices
      summary: Retrieve payment schedules for an invoice
      description: |
        This endpoint retrieves payment schedules created for an invoice.
      operationId: retrieve_payment_schedules_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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
                  payment_schedules:
                    type: array
                    description: |
                      Resource object representing payment_schedule
                    items:
                      $ref: "#/components/schemas/PaymentSchedule"
                      description: Resource object representing payment_schedule
                    example: null
                required:
                - payment_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: []
  /invoices/{invoice-id}/write_off:
    post:
      tags:
      - invoices
      summary: Write off an invoice
      description: "Write off the specified invoice.\n\nUse this operation to mark\
        \ invoices as settled when they remain unpaid after multiple attempts to collect\
        \ payment.\n\n#### Reverse a write-off\n\nYou can reverse the write-off by\
        \ [removing the linked credit note](/docs/api/invoices/remove-credit-note-from-an-invoice).\
        \  \n\n### Prerequisites \\& Constraints\n\n* There must be no in-progress\
        \ payments for the invoice.\n* The invoice `status` must be `payment_due`,\
        \ `posted`, or `not_paid`.  \n\n### Impacts\n\n**Invoice**  \n* Chargebee\
        \ sets the invoice `status` to `paid`.\n* Chargebee sets the invoice `write_off_amount`\
        \ to the invoice `amount_due`.  \n**Credit Note**  \n* Chargebee creates a\
        \ credit note with the following attributes:\n  * `type` is `adjustment`.\n\
        \  * `create_reason_code` is `Write Off`.\n* `total` is `invoice.amount_due`.\
        \  \n**Payment Schedules**  \n* If the invoice has an associated [`payment_schedule`](/docs/api/payment_schedules)\
        \ [created](/docs/api/invoices/apply-payment-schedule-scheme-to-an-invoice)\
        \ against it, Chargebee marks the schedule as paid. Chargebee sets [`schedule_entries[].status`](/docs/api/payment_schedules/payment_schedule-object#schedule_entries)\
        \ to `paid`.  \n**RevRec**  \n* To understand how write-offs sync to RevRec,\
        \ see the [write-off sync documentation](https://www.chargebee.com/docs/revrec/revenue-recognition/recognizing-chargebee-credit-notes#use-case-cancel-write-off).\n\
        * To understand how write-offs affect bad debt expenses in RevRec, see the\
        \ [bad debt expense documentation](https://www.chargebee.com/docs/revrec/revenue-recognition/bad-debt-expense).\
        \  \n**Accounting Integrations**  \n* Write-offs sync to accounting platforms\
        \ based on configured sync rules. For more details, see the following documentation:\n\
        \  * [Intacct](https://www.chargebee.com/docs/billing/2.0/integrations/intacct-config#account-mapping-for-invoice-line-items)\n\
        * [NetSuite](https://www.chargebee.com/docs/billing/2.0/integrations/netsuite-config)\
        \  \n\n### Implementation Notes\n\nBefore calling this API, ensure the following:\n\
        \n* `invoice.status` is `payment_due`, `posted`, or `not_paid`.\n* `invoice.linked_payments[i].txn_status`\
        \ is not `in_progress`. If it is, then wait for the `txn_status` to be finalized.\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing invoice
                  credit_note:
                    $ref: "#/components/schemas/CreditNote"
                    description: |
                      Resource object representing credit_note
                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}/add_charge_item:
    post:
      tags:
      - invoices
      summary: Add a charge-item to a pending invoice
      description: |
        This endpoint is used when [metered billing](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing) is enabled and it adds a [charge-item price](/docs/api/item_prices) to a `pending` invoice. To collect the accumulated charges by closing the invoice, call [Close a pending invoice](/docs/api/invoices/close-a-pending-invoice).
      operationId: add_a_charge-item_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
                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
                item_price:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_price
                  properties:
                    item_price_id:
                      type: string
                      deprecated: false
                      description: |
                        A unique ID for your system to identify the item price.
                      maxLength: 100
                      example: null
                    quantity:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Item price quantity
                      minimum: 1
                      example: null
                    quantity_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      maxLength: 33
                      example: null
                    unit_price:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        The price or per-unit-price of the item price. By default, it is the [value set](/docs/api/item_prices/item_price-object#price)
                        for the `item_price`.
                        This is only applicable when the `pricing_model`
                        of the `item_price`
                        is `flat_fee`
                        or `per_unit`.
                        The value depends on the [type of currency](/docs/api/currencies)
                        .
                      minimum: 0
                      example: null
                    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/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 item starts.
                      example: null
                    date_to:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The time when the service period for the item ends.
                      example: null
                  required:
                  - item_price_id
                  example: null
                item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_tiers
                  properties:
                    starting_unit:
                      type: array
                      description: |
                        The lowest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The highest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |
                        The per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        The total cost for the item price when the `pricing_model`
                        is `stairstep`.
                        The value is in the minor unit of the currency.
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/invoices/add-a-charge-item-to-a-pending-invoice)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    pricing_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Pricing type for the tier.

                          * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                          * flat_fee -
                            Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                            pricing model, `pricing_type`
                            will be set to `flat_fee`
                            by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                          * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                        enum:
                        - per_unit
                        - flat_fee
                        - package
                        example: null
                      example: null
                    package_size:
                      type: array
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              item_price:
                style: deepObject
                explode: true
              item_tiers:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: |
                      Resource object representing invoice
                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}/pause_dunning:
    post:
      tags:
      - invoices
      summary: Pause dunning for invoice
      description: |
        Pause [dunning](https://www.chargebee.com/docs/payments/2.0/dunning-v2.html) for the specified invoice until `expected_payment_date`. Chargebee cancels all configured payment collection [retry attempts](https://www.chargebee.com/docs/payments/2.0/dunning-v2.html) and dunning [email notifications](https://www.chargebee.com/docs/payments/2.0/dunning-v2.html#dunning-email-notifications) for the invoice until `expected_payment_date`.

        #### Prerequisites

        This operation is only permitted for an invoice that meets *all* the following conditions:

        * The [status](/docs/api/invoices/invoice-object#status) of the invoice is `payment_due`.
        * The invoice belongs to a [subscription](/docs/api/subscriptions) or [customer](/docs/api/customers) with [`auto_collection`](/docs/api/v2/pcv-1/subscriptions/subscription-object#auto_collection) set to `on`.
        * The invoice does not have dunning paused currently.

        #### Automatic dunning resumption {#dunning_resume_process}

        Unless you [resume dunning](/docs/api/invoices/resume-dunning-for-invoice) for the invoice, Chargebee attempts to collect payment on the `expected_payment_date`. If payment collection fails, the next action is taken as follows:

        * If the `expected_payment_date` 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.
        * If the `expected_payment_date` is after the dunning period for the invoice, the [final action](https://www.chargebee.com/docs/payments/2.0/dunning-v2.html) configured in Billing is initiated for the invoice and, if applicable, for the subscription.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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/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: |
                      Resource object representing invoice
                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:
      tags:
      - invoices
      summary: List invoices
      description: |
        Lists all the Invoices.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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\] = "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\] = "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.\n* `posted` - Indicates\
                \ the payment is not yet collected and will be in this state till\
                \ the due date to indicate the due period\n* `payment_due` - Indicates\
                \ the payment is not yet collected and is being retried as per retry\
                \ settings.\n* `not_paid` - Indicates the payment is not made and\
                \ all attempts to collect is failed.\n* `voided` - Indicates a voided\
                \ invoice.\n* `pending` -\n  The [invoice](/docs/api/invoices?prod_cat_ver=2#invoice_status)\
                \ is yet to be closed (sent for payment collection). An invoice is\
                \ generated with this `status` when it has line items that belong\
                \ to items that are `metered` or when the `subscription.create_pending_invoices`attribute\
                \ is set to `true`.  \n  The [invoice](/docs/api/invoices?prod_cat_ver=1#invoice_status)\
                \ is yet to be closed (sent for payment collection). All invoices\
                \ are generated with this `status` when [Metered Billing](https://www.chargebee.com/docs/1.0/metered_billing.html)\
                \ is enabled for the site.\n"
              enum:
              - paid
              - posted
              - payment_due
              - not_paid
              - voided
              - pending
              example: null
            is_not:
              type: string
              description: "* `paid` - Indicates a paid invoice.\n* `posted` - Indicates\
                \ the payment is not yet collected and will be in this state till\
                \ the due date to indicate the due period\n* `payment_due` - Indicates\
                \ the payment is not yet collected and is being retried as per retry\
                \ settings.\n* `not_paid` - Indicates the payment is not made and\
                \ all attempts to collect is failed.\n* `voided` - Indicates a voided\
                \ invoice.\n* `pending` -\n  The [invoice](/docs/api/invoices?prod_cat_ver=2#invoice_status)\
                \ is yet to be closed (sent for payment collection). An invoice is\
                \ generated with this `status` when it has line items that belong\
                \ to items that are `metered` or when the `subscription.create_pending_invoices`attribute\
                \ is set to `true`.  \n  The [invoice](/docs/api/invoices?prod_cat_ver=1#invoice_status)\
                \ is yet to be closed (sent for payment collection). All invoices\
                \ are generated with this `status` when [Metered Billing](https://www.chargebee.com/docs/1.0/metered_billing.html)\
                \ is enabled for the site.\n"
              enum:
              - paid
              - posted
              - payment_due
              - not_paid
              - voided
              - pending
              example: null
            in:
              type: string
              description: "* `paid` - Indicates a paid invoice.\n* `posted` - Indicates\
                \ the payment is not yet collected and will be in this state till\
                \ the due date to indicate the due period\n* `payment_due` - Indicates\
                \ the payment is not yet collected and is being retried as per retry\
                \ settings.\n* `not_paid` - Indicates the payment is not made and\
                \ all attempts to collect is failed.\n* `voided` - Indicates a voided\
                \ invoice.\n* `pending` -\n  The [invoice](/docs/api/invoices?prod_cat_ver=2#invoice_status)\
                \ is yet to be closed (sent for payment collection). An invoice is\
                \ generated with this `status` when it has line items that belong\
                \ to items that are `metered` or when the `subscription.create_pending_invoices`attribute\
                \ is set to `true`.  \n  The [invoice](/docs/api/invoices?prod_cat_ver=1#invoice_status)\
                \ is yet to be closed (sent for payment collection). All invoices\
                \ are generated with this `status` when [Metered Billing](https://www.chargebee.com/docs/1.0/metered_billing.html)\
                \ is enabled for the site.\n"
              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.\n* `posted` - Indicates\
                \ the payment is not yet collected and will be in this state till\
                \ the due date to indicate the due period\n* `payment_due` - Indicates\
                \ the payment is not yet collected and is being retried as per retry\
                \ settings.\n* `not_paid` - Indicates the payment is not made and\
                \ all attempts to collect is failed.\n* `voided` - Indicates a voided\
                \ invoice.\n* `pending` -\n  The [invoice](/docs/api/invoices?prod_cat_ver=2#invoice_status)\
                \ is yet to be closed (sent for payment collection). An invoice is\
                \ generated with this `status` when it has line items that belong\
                \ to items that are `metered` or when the `subscription.create_pending_invoices`attribute\
                \ is set to `true`.  \n  The [invoice](/docs/api/invoices?prod_cat_ver=1#invoice_status)\
                \ is yet to be closed (sent for payment collection). All invoices\
                \ are generated with this `status` when [Metered Billing](https://www.chargebee.com/docs/1.0/metered_billing.html)\
                \ is enabled for the site.\n"
              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\[on\] = "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\[gt\] = "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: |
          optional, in cents filter

          Payments collected successfully for the invoice. This is the sum of [linked_payments[]](/docs/api/invoices/invoice-object#linked_payments)`.txn_amount`
          for all `linked_payments[]`
          that have `txn_status`
          as `success`.
          **Supported operators :**
          is, is_not, lt, lte, gt, gte, between

          **Example →**
          *amount_paid\[lt\] = "800"*
        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\[gte\] = "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\[lte\] = "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: |
          optional, in cents filter

          The unpaid amount that is due on the invoice. This is calculated as: [total](/docs/api/invoices/invoice-object#total)

          * [amount_paid](/docs/api/invoices/invoice-object#amount_paid)
          * sum of [applied_credits](/docs/api/invoices/invoice-object#applied_credits)`.applied_amount`
          * sum of [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)`.cn_total`
          * sum of [linked_taxes_withheld](/docs/api/invoices/invoice-object#linked_taxes_withheld)`.amount`. **Supported operators :** is, is_not, lt, lte, gt, gte, between

          **Example →**
          *amount_due\[lt\] = "200"*
        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: |
          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. It is advisable when using this filter, to pass the `sort_by`
          input parameter as `updated_at`
          for a faster response.
          **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: 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.\n* `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.\n* `play_store` -\n  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.  \n  In-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.\n* `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.\n* `play_store` -\n  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.  \n  In-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.\n* `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.\n* `play_store` -\n  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.  \n  In-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.\n* `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.\n* `play_store` -\n  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.  \n  In-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\[on\] = "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_not\] = "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: |
                The status of processing the e-invoice. To obtain detailed information about the current `status`
                , see `message`
                .
              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 `entity_identifier` 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 `entity_identifier` 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 `entity_identifier` 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 `entity_identifier` 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: []
  /invoices/{invoice-id}/void_before_capture:
    post:
      tags:
      - invoices
      summary: Void authorizations before capture
      description: "Voids all outstanding scheduled-capture authorizations linked\
        \ to an invoice before capture, then voids or writes off the invoice.\n\n\
        Use this operation when an invoice has an outstanding delayed-capture authorization\
        \ that must be released before the invoice is either voided or written off.\
        \ Use `invoice_action` to choose whether the invoice is voided or written\
        \ off.  \n\n### Prerequisites \\& Constraints\n\n* The invoice must have at\
        \ least one outstanding scheduled-capture authorization with a capturable\
        \ amount greater than zero.\n* The invoice `status` must be `payment_due`,\
        \ `posted`, or `not_paid`.\n* The invoice must not have successful payments,\
        \ taxes withheld, applied credit notes, adjustment amounts, refundable credits,\
        \ or refunds in progress.\n* The outstanding authorization must not already\
        \ have a successful or in-progress capture.\n* This operation is not supported\
        \ for 2Checkout.  \n\n### Impacts\n\n**Authorizations**  \n* Chargebee voids\
        \ all eligible outstanding scheduled-capture authorizations linked to the\
        \ invoice at the payment gateway.  \n**Invoice**  \n* When `invoice_action`\
        \ is `void`, Chargebee voids the invoice. The invoice `status` becomes `voided`.\n\
        * When `invoice_action` is `write_off`, Chargebee writes off the invoice.\
        \ The invoice `status` becomes `paid`, and `write_off_amount` is set to the\
        \ invoice `amount_due`.  \n**Credit Note**  \n* When `invoice_action` is `write_off`,\
        \ Chargebee creates an adjustment credit note for the write-off. The response\
        \ includes the `credit_note` resource when one is generated.  \n\n### Implementation\
        \ Notes\n\nBefore calling this API, ensure that the scheduled-capture authorization\
        \ is still outstanding. If it has already been captured, if no eligible authorization\
        \ remains, or if another conflicting payment operation is in progress, the\
        \ API returns HTTP `409` with `api_error_code` set to `invalid_state_for_request`.\n"
      operationId: void_authorizations_before_capture
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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. Applicable only when `invoice_action` is `void`. Select from the reason codes configured in **Settings \> Configure Chargebee \> Reason Codes \> Invoices \> Void invoice**. This parameter is required when a void reason code is configured as mandatory. The codes are case-sensitive.
                  maxLength: 100
                  example: null
                invoice_action:
                  type: string
                  deprecated: false
                  description: "Determines whether Chargebee voids or writes off the\
                    \ invoice after voiding all eligible outstanding scheduled-capture\
                    \ authorizations. Possible values are `void` and `write_off`.\
                    \ This is not related to [Close a pending invoice](/docs/api/invoices#close_a_pending_invoice).\
                    \  \n**Default value**\n\n`void`\n\n* void - Voids the invoice\
                    \ after all eligible outstanding scheduled-capture authorizations\
                    \ are voided.\n* write_off - Writes off the invoice after all\
                    \ eligible outstanding scheduled-capture authorizations are voided.\
                    \ `void_reason_code` is not applicable for this value.\n"
                  enum:
                  - void
                  - write_off
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: |
                      Resource object representing invoice
                  credit_note:
                    $ref: "#/components/schemas/CreditNote"
                    description: |
                      Resource object representing credit_note
                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:
      tags:
      - invoices
      summary: Close a pending invoice
      description: |
        Invoices for a subscription are created with a `pending` `status` when the subscription has `create_pending_invoices` attribute set to `true`. This API call finalizes a `pending` invoice. Any `refundable_credits` and `excess_payments` for the customer are applied to the invoice, and any payment due is collected automatically if `auto_collection` is `on` for the customer.

        #### Automation

        This operation can be automated by using a [site setting](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing). Moreover, the automation can be overridden at the [customer](/docs/api/customers/customer-object#auto_close_invoices) and [subscription](/docs/api/subscriptions/subscription-object#auto_close_invoices) level.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    Set as `true`
                    to remove the [**general note**](https://www.chargebee.com/docs/invoice_notes.html#adding-general-notes)
                    from this invoice.
                  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: |
                          Type of entity to which the [note](/docs/api/invoices/invoice-object#notes)
                          belongs. To remove the general note, use the `remove_general_note`
                          parameter.

                          * customer - Entity that represents a customer.
                          * charge_item_price - Indicates that this line item is based on charge Item Price
                          * coupon - Entity that represents a coupon.
                          * addon_item_price - Indicates that this line item is based on addon Item Price
                          * subscription - Entity that represents a subscription of customer.
                          * plan_item_price - Indicates that this line item is based on plan Item Price
                        enum:
                        - customer
                        - subscription
                        - coupon
                        - plan_item_price
                        - addon_item_price
                        - charge_item_price
                        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: |
                      Resource object representing invoice
                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:
      tags:
      - invoices
      summary: Apply credits for an invoice
      description: "Applies a customer's [refundable credits](/docs/api/customers/customer-object#refundable_credits)\
        \ to a specified invoice.\n\nYou can either specify the credit notes to be\
        \ applied, or let Chargebee apply the available credit notes automatically.\
        \  \n\n### Prerequisites \\& Constraints\n\n* The customer must have refundable\
        \ credits available.\n* The invoice `status` must be `not_paid`, `payment_due`,\
        \ or `posted`.  \n\n### Impacts\n\n**Invoice**  \n* The `amount_due` decreases\
        \ by the amount of credits applied.\n* The invoice `status`:\n  * changes\
        \ to `paid` if the applied credits fully cover the amount due.\n* remains\
        \ unchanged if the applied credits only partially cover the amount due.  \n\
        **Credit Notes**  \nThe credit note `status`:\n\n* changes to `refunded` if\
        \ the entire `credit_note.amount_available` is applied to the invoice.\n*\
        \ remains `refund_due` if only part of the `credit_note.amount_available`\
        \ is applied.  \n\n### Implementation Notes\n\nBefore calling this API, make\
        \ sure the following conditions are met:\n\n* `customer.refundable_credits`\
        \ is non-zero.\n* The invoice `status` is `not_paid`, `payment_due`, or `posted`.\n\
        * The `credit_note.customer_id` matches the `invoice.customer_id`.  \n\n####\
        \ Related APIs\n\n[Apply payments for an invoice](/docs/api/invoices?prod_cat_ver=2#apply_payments_for_an_invoice)[Collect\
        \ payment for an invoice](/docs/api/invoices?prod_cat_ver=2#collect_payment_for_an_invoice)[Record\
        \ an invoice payment](/docs/api/invoices?prod_cat_ver=2#record_an_invoice_payment)\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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 ID of the credit note to be applied to the\
                        \ invoice.  \n**Constraints**\n\n* `credit_note.type` must\
                        \ be `refundable`.\n* The `credit_note.customer_id` must always\
                        \ be the same as `invoice.customer_id` even if `invoice.payment_owner`\
                        \ is different.  \n**Default behavior**\n\nWhen the parameter\
                        \ is not passed, [available refundable credits](/docs/api/customers/customer-object#refundable_credits)\
                        \ with the customer are applied to the invoice.\n"
                      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: |
                      Resource object representing invoice
                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_email:
    post:
      tags:
      - invoices
      summary: Send Invoice Email
      description: "Sends the invoice email to the customer using the site's published\
        \ **Send Invoice Email** Engage notification template.\n\nUse this operation\
        \ to resend or manually trigger the invoice email for a customer outside the\
        \ normal notification schedule.  \n**Async-only**\nThis operation is [asynchronous\
        \ only](/docs/api/async_response). You must send `Prefer: respond-async`,\
        \ a unique `chargebee-request-id`, and a `chargebee-async-callback-url`. The\
        \ HTTP response is `202 Accepted` with an empty body. When processing completes,\
        \ Chargebee delivers the outcome to your [async callback URL](/docs/api/async_response)\
        \ --- a successful `result` contains [`email_logs`](/docs/api/email_logs).\
        \  \n\n### Prerequisites \\& Constraints\n\n* Email Engage V2 must be enabled\
        \ for the site.\n* The **Send Invoice Email** notification template must be\
        \ published and enabled.\n* The from address configured for the notification\
        \ template must be verified.\n* The customer associated with the invoice must\
        \ have a valid email address.\n* The invoice `status` must be `paid`, `payment_due`,\
        \ `not_paid`, or `posted`.\n"
      operationId: send_invoice_email
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: Prefer
        in: header
        description: Must be set to `respond-async`. Instructs Chargebee to process
          the request asynchronously and return `202 Accepted` immediately.
        required: true
        deprecated: false
        $ref: "#/components/parameters/Prefer"
        style: simple
        explode: false
        schema:
          type: string
          description: Must be set to `respond-async`. Instructs Chargebee to process
            the request asynchronously and return `202 Accepted` immediately.
          example: respond-async
      - name: chargebee-request-id
        in: header
        description: "A client-generated unique identifier (UUID recommended) for\
          \ this request. Echoed back as `request.id` in the async callback payload,\
          \ allowing you to correlate each callback to its originating request."
        required: true
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "A client-generated unique identifier (UUID recommended) for\
            \ this request. Echoed back as `request.id` in the async callback payload,\
            \ allowing you to correlate each callback to its originating request."
          example: 7c9e2f4a-8b1d-4e6f-9a0c-3d5e7f9b1c2d
          maxLength: 100
      - name: chargebee-async-callback-url
        in: header
        description: "The callback URL where Chargebee will `POST` the async result.\
          \ Must be an `https://` URL and may embed basic-auth credentials, e.g. `https://username:password@example.com`."
        required: true
        deprecated: false
        $ref: "#/components/parameters/chargebee-async-callback-url"
        style: simple
        explode: false
        schema:
          type: string
          format: uri
          description: "The callback URL where Chargebee will `POST` the async result.\
            \ Must be an `https://` URL and may embed basic-auth credentials, e.g.\
            \ `https://username:password@example.com`."
          example: https://username:password@example.com
      - 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:
                  email_logs:
                    type: array
                    description: |
                      List of [email log](/docs/api/email_logs) objects for the send request. Each entry describes one email that was sent or attempted.
                    items:
                      $ref: "#/components/schemas/EmailLog"
                      description: Resource object representing email_log
                    example: null
                required:
                - email_logs
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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:
      tags:
      - invoices
      summary: Retrieve an invoice
      description: |
        Retrieve the invoice for the specified invoice id.
      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: "Specify the starting point for retrieving line items. Use the\
          \ value from the `line_items_next_offset` attribute of the previous retrieve\
          \ API 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: 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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing invoice
                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/create_for_charge_items_and_charges:
    post:
      tags:
      - invoices
      summary: Create invoice for items and one-time charges
      description: "Creates an invoice for [charge-items](/docs/api/items) and [one-time\
        \ charges](https://www.chargebee.com/docs/billing/2.0/product-catalog/charges#adding-quick-charges).\
        \ The item prices must belong to items of `type` `charge`.\n\nYou can optionally\
        \ override the line item name and description displayed on the invoice for\
        \ charge-item prices and one-time charges. When `create_pending_invoice` is\
        \ `true`, the invoice is created in `pending` status without collecting payment.\
        \ You can review the invoice, add more charges if needed, and close it later\
        \ via the [close a pending invoice](/docs/api/invoices/close-a-pending-invoice)\
        \ operation.  \nOne-time charges are represented in an invoice as `line_items`\
        \ with `entity_type` `adhoc`.\n"
      operationId: create_invoice_for_items_and_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
              properties:
                customer_id:
                  type: string
                  deprecated: false
                  description: "Unique ID of the customer this invoice should be created\
                    \ for. Either this or `subscription_id` must be provided.  \n\
                    **Note**\n\nThe invoice is [linked](/docs/api/getting-started)\
                    \ to the same [business entity](/docs/api/getting-started) as\
                    \ this customer.\n"
                  maxLength: 50
                  example: null
                subscription_id:
                  type: string
                  deprecated: false
                  description: "Unique ID of the subscription this invoice should\
                    \ be created for. Either this or `customer_id` must be provided.\
                    \  \n**Note**\n\nThe invoice is [linked](/docs/api/getting-started)\
                    \ to the same [business entity](/docs/api/getting-started) as\
                    \ this subscription.\n"
                  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_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: |
                    Set as `true`
                    to remove the [**general note**](https://www.chargebee.com/docs/invoice_notes.html#adding-general-notes)
                    from this invoice.
                  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.  \n**Note**\n\n* When `create_pending_invoice`\
                    \ is `true`, `auto_collection` cannot be passed. When the pending\
                    \ invoice is closed, the [subscription](/docs/api/subscriptions/subscription-object#auto_collection)\
                    \ `auto_collection` setting is used when available; otherwise,\
                    \ the [customer](/docs/api/customers/customer-object#auto_collection)\
                    \ `auto_collection` setting applies.\n\n* on - Whenever an invoice\
                    \ is created, an automatic attempt will be made to charge.\n*\
                    \ off - Whenever an invoice is created as payment due.\n"
                  enum:
                  - "on"
                  - "off"
                  example: null
                net_term_days:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The [Net D](https://www.chargebee.com/docs/billing/2.0/subscriptions/net_d) value explicitly set for this invoice. Net D is the number of days within which the invoice must be paid. When this value is provided, it overrides the payment terms defined at the subscription or customer level. **Note:** This value is used only for this invoice operation and does not update the customer or subscription records.
                  example: null
                invoice_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    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.
                    `taxes`
                    and
                    `line_item_taxes`
                    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.
                  example: null
                create_pending_invoice:
                  type: boolean
                  deprecated: false
                  description: "When set to `true`, the invoice is created with `status`\
                    \ as `pending` and payment is not collected. The invoice can be\
                    \ closed later via the [close a pending invoice](/docs/api/invoices/close-a-pending-invoice)\
                    \ operation.  \n**Prerequisites**\n\n* [Usage-based billing](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/setting-up-usage-based-billing)\
                    \ must be enabled for the site.\n* `subscription_id` must be provided.\
                    \  \n**Constraints**\n\n* Payment collection parameters cannot\
                    \ be passed when this parameter is `true`. This includes `payment_source_id`,\
                    \ `authorization_transaction_id`, `auto_collection`, `payment_method`\
                    \ parameters, `card` parameters, `payment_intent` parameters,\
                    \ and `token_id`.\n* `auto_collection` cannot be overridden on\
                    \ this request. When the pending invoice is closed, the [subscription](/docs/api/subscriptions/subscription-object#auto_collection)\
                    \ or [customer](/docs/api/customers/customer-object#auto_collection)\
                    \ `auto_collection` setting applies.\n"
                  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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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 supported\
                        \ only for Stripe, Adyen, and Chargebee Payments.\n\n* cartes_bancaires\
                        \ - A Cartes Bancaires card scheme.\n* mastercard - A MasterCard\
                        \ scheme.\n* dankort - A Dankort card scheme. Supported only\
                        \ for Adyen and Chargebee Payments.\n* visa - A Visa card\
                        \ scheme.\n"
                      enum:
                      - cartes_bancaires
                      - mastercard
                      - visa
                      - dankort
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `billing_state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    billing_state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `billing_state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      maxLength: 50
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |
                        * `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal).

                          * `payer`: User related information.
                            * `country_of_residence`: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a [two-character ISO code](https://docs.checkout.com/resources/codes/country-codes).
                            * `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
                        * `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
                        * `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user's `device_session_id` can be added to perform [additional validation](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                            * `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
                        * `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
                        * `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                        * `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.

                          * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
                        * `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.

                          * `payer`: User related information.
                            * `document`: Document is the user's identification number based on their country.
                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device
                      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: |
                        The billing address associated with the bank account. The value is a JSON object with the following keys and their values:- `first_name`:(string, max chars=150) The first name of the contact.

                        * `last_name`:(string, max chars=150) The last name of the contact.
                        * `company_name`:(string, max chars=250) The company name for the address.
                        * `line1`:(string, max chars=180) The first line of the address.
                        * `line2`:(string, max chars=180) The second line of the address.
                        * `country`:(string) The name of the country for the address.
                        * `country_code`:(string, max chars=50) The two-letter, [ISO 3166 alpha-2](https://www.iso.org/iso-3166-country-codes.html) country code for the address.
                        * `state`:(string, max chars=50) The name of the state or province for the address. When not provided, this is set automatically for US, Canada, India, and UAE.
                        * `state_code`:(string, max chars=50) The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code/) without the country prefix. This is supported for USA, Canada, India, and UAE. For instance, for Arizona (USA), set state_code as `AZ` (not `US-AZ`). For Tamil Nadu (India), set as `TN` (not `IN-TN`). For British Columbia (Canada), set as `BC` (not `CA-BC`). For Dubai (UAE), set as `DU` (not `AE-DU`).
                        * `city`:(string, max chars=50) The city name for the address.
                        * `postal_code`:(string, max chars=20) The postal or ZIP code for the address.
                        * `phone`:(string, max chars=50) The contact phone number for the address.
                        * `email`:(string, max chars=70) The contact email address for the address.
                      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\n* grab_pay - Payments made\
                        \ via GrabPay\n* go_pay - Payments made via GoPay\n* nequi\
                        \ - Payments made via Nequi.\n* google_pay - Payments made\
                        \ via Google Pay.\n* after_pay - Payments made via Afterpay\n\
                        * qpay - Payments made via Qpay.\n* pix - Payments made via\
                        \ Pix\n* pay_by_bank - Pay By Bank\n* sofort - Payments made\
                        \ via Sofort.\n* twint - Payments made via Twint\n* netbanking_emandates\
                        \ - Netbanking (eMandates) Payments.\n* apple_pay - Payments\
                        \ made via Apple Pay.\n* unionpay - Payments made via UnionPay.\n\
                        * giropay - Payments made via giropay.\n* direct_debit - Represents\
                        \ bank account for which the direct debit or ACH agreement/mandate\
                        \ is created.\n* rakuten_pay - Payments made via Rakuten Pay.\n\
                        * ovo - Payments made via OVO.\n* mercado_pago - Payments\
                        \ made via Mercado Pago.\n* paypay - Payments made via PayPay\n\
                        * south_korean_cards - Payments made via South Korean Cards\n\
                        * bancontact - Payments made via Bancontact Card.\n* upi -\
                        \ UPI Payments.\n* revolut_pay - Payments made via Revolut\
                        \ Pay.\n* stablecoin - Payments made via Stablecoin.\n* alipay\
                        \ -\n  Payments made via Alipay.  \n  This payment source\
                        \ is deprecated.\n* tamara - Payments made via Tamara.\n*\
                        \ payme - Payments made via PayMe\n* pay_to - Payments made\
                        \ via PayTo\n* pay_co - Payments made via PayCo\n* picpay\
                        \ - Payments made via PicPay.\n* kakao_pay - Payments made\
                        \ via Kakao Pay.\n* fpx - Payments made via FPX.\n* wechat_pay\
                        \ -\n  Payments made via WeChat Pay.  \n  This payment source\
                        \ is deprecated.\n* sepa_instant_transfer - Payments made\
                        \ via Sepa Instant Transfer\n* dotpay - Payments made via\
                        \ Dotpay.\n* p24 - Payments made via Przelewy24 (P24).\n*\
                        \ klarna - Payments made via Klarna.\n* paypal_express_checkout\
                        \ - Payments made via PayPal Express Checkout.\n* ideal -\
                        \ Payments made via iDEAL.\n* affirm_pay - Payments made via\
                        \ Affirm Pay.\n* electronic_payment_standard - Electronic\
                        \ Payment Standard\n* generic - Payments made via Generic\
                        \ Payment Method.\n* klarna_pay_now - Payments made via Klarna\
                        \ Pay Now\n* faster_payments - Payments made via Faster Payments\n\
                        * thai_qr - Payments made via Thai QR.\n* swish - Payments\
                        \ made via Swish\n* venmo - Payments made via Venmo\n* payconiq_by_bancontact\
                        \ - Payments made via Payconiq by Bancontact.\n* naver_pay\
                        \ - Payments made via Naver Pay.\n* wero - Payments made via\
                        \ Wero.\n* touch_n_go - Payments made via Touch 'n Go.\n*\
                        \ momo - Payments made via MoMo.\n* blik - Payments made via\
                        \ BLIK.\n* dana - Payments made via Dana.\n* automated_bank_transfer\
                        \ - Represents virtual bank account using which the payment\
                        \ will be done.\n* amazon_payments - Payments made via Amazon\
                        \ Payments.\n* gcash - Payments made via GCash.\n* card -\
                        \ Card based payment including credit cards and debit cards.\
                        \ Details about the card can be obtained from the card resource.\n\
                        * online_banking_poland - Payments made via Online Banking\
                        \ Poland\n* nupay - Payments made via NuPay.\n* trustly -\
                        \ Trustly\n* kbc_payment_button - KBC Payment Button\n* alipay_hk\
                        \ - Payments made via Alipay HK.\n* cash_app_pay - Payments\
                        \ 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
                      - alipay_hk
                      - paypay
                      - gcash
                      - south_korean_cards
                      - paynow
                      - bizum
                      - promptpay
                      - dana
                      - touch_n_go
                      - tamara
                      - qpay
                      - ovo
                      - momo
                      - mercado_pago
                      - nequi
                      - nupay
                      - picpay
                      - thai_qr
                      - blik
                      - fpx
                      - wero
                      - p24
                      - affirm_pay
                      - rakuten_pay
                      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: |
                        [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)
                        .

                        **Note**:
                        If you enter an invalid country code, the system will return an error.

                        If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)
                        in 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)
                        the Brexit configuration, then `XI`
                        (the code for **United Kingdom - Northern Ireland**
                        ) is available as an option.
                      maxLength: 50
                      example: null
                    additional_information:
                      type: object
                      additionalProperties: true
                      deprecated: false
                      description: |
                        * `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal).

                          * `payer`: User related information.
                            * `country_of_residence`: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a [two-character ISO code](https://docs.checkout.com/resources/codes/country-codes).
                            * `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
                        * `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
                        * `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user's `device_session_id` can be added to perform [additional validation](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                            * `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
                        * `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
                        * `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                        * `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.

                          * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
                        * `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.

                          * `payer`: User related information.
                            * `document`: Document is the user's identification number based on their country.
                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device
                      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
                        * klarna - Payments made via Klarna.
                        * 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
                        * picpay - Payments made via PicPay.
                        * ovo - Payments made via OVO.
                        * boleto - boleto
                        * wechat_pay - Payments made via WeChat Pay.
                        * after_pay - Payments made via Afterpay
                        * grab_pay - Payments made via GrabPay
                        * mercado_pago - Payments made via Mercado Pago.
                        * direct_debit - direct_debit
                        * sepa_instant_transfer -
                        * bancontact - bancontact
                        * touch_n_go - Payments made via Touch 'n Go.
                        * qpay - Payments made via Qpay.
                        * momo - Payments made via MoMo.
                        * affirm_pay - Payments made via Affirm Pay.
                        * kakao_pay - Payments made via Kakao Pay.
                        * blik - Payments made via BLIK.
                        * dana - Payments made via Dana.
                        * south_korean_cards - Payments made via South Korean Cards
                        * swish - Payments made via Swish
                        * thai_qr - Payments made via Thai QR.
                        * 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.
                        * tamara - Payments made via Tamara.
                        * pay_to -
                        * pay_co - Payments made via PayCo
                        * cash_app_pay - Payments made via Cash App Pay.
                        * rakuten_pay - Payments made via Rakuten Pay.
                        * alipay_hk - Payments made via Alipay HK.
                        * netbanking_emandates - netbanking_emandates
                        * nequi - Payments made via Nequi.
                        * paypay - PayPay
                        * payconiq_by_bancontact - Payments made via Payconiq by Bancontact.
                        * p24 - Payments made via Przelewy24 (P24).
                        * electronic_payment_standard - Electronic Payment Standard
                        * wero - Payments made via Wero.
                        * pay_by_bank - Pay By Bank
                        * apple_pay - apple_pay
                        * online_banking_poland - Online Banking Poland
                        * gcash - Payments made via GCash.
                        * nupay - Payments made via NuPay.
                        * giropay - giropay
                        * sofort - sofort
                        * amazon_payments - amazon_payments
                        * fpx - Payments made via FPX.
                        * 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
                      - alipay_hk
                      - paypay
                      - gcash
                      - south_korean_cards
                      - paynow
                      - bizum
                      - promptpay
                      - dana
                      - touch_n_go
                      - tamara
                      - qpay
                      - ovo
                      - momo
                      - mercado_pago
                      - nequi
                      - nupay
                      - picpay
                      - thai_qr
                      - blik
                      - fpx
                      - wero
                      - p24
                      - affirm_pay
                      - rakuten_pay
                      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: |
                        * `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal).

                          * `payer`: User related information.
                            * `country_of_residence`: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a [two-character ISO code](https://docs.checkout.com/resources/codes/country-codes).
                            * `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
                        * `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
                        * `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user's `device_session_id` can be added to perform [additional validation](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                            * `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
                        * `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
                        * `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                        * `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.

                          * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
                        * `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.

                          * `payer`: User related information.
                            * `document`: Document is the user's identification number based on their country.
                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device
                      example: null
                  example: null
                item_prices:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_prices
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        A unique ID for your system to identify the item price.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Item price quantity
                      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 item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        The price or per-unit-price of the item price. By default, it is the [value set](/docs/api/item_prices/item_price-object#price)
                        for the `item_price`.
                        This is only applicable when the `pricing_model`
                        of the `item_price`
                        is `flat_fee`
                        or `per_unit`.
                        The value depends on the [type of currency](/docs/api/getting-started)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      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/getting-started)
                        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 item 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 item ends.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    description:
                      type: array
                      description: "The line item name to display on the invoice for\
                        \ this charge item.  \n**Default value**\n\n* The invoice\
                        \ name defined for the item in the product catalog.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 250
                        example: null
                      example: null
                    entity_description:
                      type: array
                      description: "Descriptive text displayed below the line item\
                        \ name on the invoice for this charge item.  \n**Default value**\n\
                        \n* The [item price description](/docs/api/item_prices/item_price-object#description)\
                        \ from the product catalog.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 2000
                        example: null
                      example: null
                  example: null
                item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_tiers
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The id of the item price to which this tier belongs.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: |
                        The lowest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The highest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |
                        The per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        The total cost for the item price when the `pricing_model`
                        is `stairstep`.
                        The value is in the minor unit of the currency.
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    pricing_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Pricing type for the tier.

                          * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                          * flat_fee -
                            Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                            pricing model, `pricing_type`
                            will be set to `flat_fee`
                            by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                          * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                        enum:
                        - per_unit
                        - flat_fee
                        - package
                        example: null
                      example: null
                    package_size:
                      type: array
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                  example: null
                charges:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for charges
                  properties:
                    entity_description:
                      type: array
                      description: |
                        Descriptive text for this one-time charge displayed on the invoice, shown below the line item name.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 2000
                        example: null
                      example: null
                    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/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    description:
                      type: array
                      description: |
                        The name of this one-time charge as displayed on the invoice line item.
                      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
                notes_to_remove:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for notes_to_remove
                  properties:
                    entity_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Type of entity to which the [note](/docs/api/invoices/invoice-object#notes)
                          belongs. To remove the general note, use the `remove_general_note`
                          parameter.

                          * charge_item_price - Indicates that this line item is based on charge Item Price
                          * plan_item_price - Indicates that this line item is based on plan Item Price
                          * coupon - Entity that represents a coupon.
                          * addon_item_price - Indicates that this line item is based on addon Item Price
                          * customer - Entity that represents a customer.
                          * subscription - Entity that represents a subscription of customer.
                        enum:
                        - customer
                        - subscription
                        - coupon
                        - plan_item_price
                        - addon_item_price
                        - charge_item_price
                        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 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
                discounts:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for discounts
                  properties:
                    percentage:
                      type: array
                      description: |
                        The percentage of the original amount that should be deducted from it.
                      items:
                        type: number
                        format: double
                        deprecated: false
                        maximum: 100
                        minimum: 0.01
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        The value of the discount. [The format of this value](/docs/api/currencies)
                        depends on the kind of currency.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Specifies the number of free units provided for the item, without affecting the total quantity sold
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    apply_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The amount on the invoice to which the discount is applied.

                          * invoice_amount -
                            The discount is applied to the invoice `sub_total`
                            .
                          * specific_item_price -
                            The discount is applied to the `invoice.line_item.amount`
                            that corresponds to the item price specified by `item_price_id`
                            .
                        enum:
                        - invoice_amount
                        - specific_item_price
                        example: null
                      example: null
                    item_price_id:
                      type: array
                      description: |
                        The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                        in the subscription to which the discount is to be applied. Relevant only when `apply_on`
                        = `specific_item_price`.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                  required:
                  - apply_on
                  example: null
              example: null
            encoding:
              bank_account:
                style: deepObject
                explode: true
              card:
                style: deepObject
                explode: true
              charges:
                style: deepObject
                explode: true
              discounts:
                style: deepObject
                explode: true
              item_prices:
                style: deepObject
                explode: true
              item_tiers:
                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: |
                      Resource object representing invoice
                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:
      tags:
      - invoices
      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:**\nThis updates the invoice only; it does not change\
        \ the corresponding customer or subscription details. You cannot update the\
        \ VAT number if the billing address is not present in the API request. If\
        \ tax would change due to an address update, the update is rejected. For [AvaTax\
        \ for Sales](https://www.chargebee.com/docs/avalara.html), `line1`--`line3`,\
        \ `city`, `state`, `state_code`, and `zip` may be updated when the Avalara\
        \ document is `SUCCESS` and `UNCOMMITTED` and a re-estimate shows unchanged\
        \ tax. Updates that change `country` or `vat_number`, use line-item-level\
        \ addresses, or apply to other third-party tax integrations are rejected.\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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    An overridden value for the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number).
                    Only applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)

                    `country`
                    as `XI`
                    (which is **United Kingdom - Northern Ireland**
                    ).

                    When you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)
                    in 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)
                    the Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)

                    `country`
                    as `XI`.
                    That's the code for **United Kingdom - Northern Ireland** .
                    The first two characters of the VAT number in such a case is
                    `XI`
                    by default. However, if the VAT number was registered in UK, the value should be `GB`.
                    Set
                    `vat_number_prefix`
                    to `GB`
                    for such cases.
                  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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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
                  description: ""
                  properties:
                    descriptor:
                      type: string
                      deprecated: false
                      description: |
                        A description of the transaction that helps your customer easily recognize it.
                      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: |
                      Resource object representing invoice
                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:
      tags:
      - invoices
      summary: Record an invoice payment
      description: "Records an [offline payment](https://www.chargebee.com/docs/payments/2.0/offline-checkout/offline_payments)\
        \ for an [invoice](/docs/api/invoices).\n\nUse this API to record payments\
        \ that you receive outside Chargebee, such as bank transfers or checks, so\
        \ that you can reconcile them against invoices.  \n\n### Prerequisites \\\
        & Constraints\n\n* The invoice [`status`](/docs/api/invoices/invoice-object#status)\
        \ must be `payment_due`, `posted`, or `not_paid`.  \n\n### Impacts\n\n**Invoice**\
        \  \n* The `amount_due` on the invoice decreases by `transaction[amount]`\
        \ when the `transaction[status]` is `success`.\n* The invoice `status` changes\
        \ to `paid` if the `amount_due` on the invoice becomes zero because of this\
        \ payment. Otherwise, the `status` remains unchanged.  \n**Customer**  \n\
        If the recorded payment exceeds the invoice's `amount_due`, the excess is\
        \ added to the customer's [`excess_payments`](/docs/api/customers/customer-object#excess_payments)\
        \ balance.  \n**Payment Schedules**  \nIf a [`payment_schedule`](/docs/api/payment_schedules)\
        \ exists for the invoice:\n\n* For a successful payment, Chargebee reduces\
        \ [`schedule_entries[].amount`](/docs/api/payment_schedules/payment_schedule-object#schedule_entries)\
        \ for the entries the payment covers. An entry whose remaining amount reaches\
        \ `0` is marked `paid`.\n* Chargebee adds the payment to [`reference_transactions[]`](/docs/api/payment_schedules/payment_schedule-object#reference_transactions),\
        \ including failed and in-progress attempts with `applied_amount` `0`.  \n\
        \n### Implementation Notes\n\nBefore calling this API, ensure the following:\n\
        \n* The invoice `status` must be `payment_due`, `posted`, or `not_paid`.\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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.  \n**Default value**\n\
                        \n* If not specified, the [`amount_due`](/docs/api/invoices/invoice-object#amount_due)\
                        \ on the invoice is considered as the payment amount.\n"
                      minimum: 0
                      example: null
                    payment_method:
                      type: string
                      deprecated: false
                      description: "The payment method of this transaction\n\n* cash\
                        \ - Cash\n* other - Payment Methods other than the above types\n\
                        * custom -\n  Custom payment method.  \n  **Prerequisite**\n\
                        \n  * [Custom payment methods](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/custom-payment-methods&ref=feature)\
                        \ must be enabled in Chargebee Billing.\n* check - Check\n\
                        * bank_transfer - Bank Transfer\n"
                      enum:
                      - cash
                      - check
                      - bank_transfer
                      - other
                      - custom
                      - tamara
                      - qpay
                      - blik
                      - fpx
                      - wero
                      - p24
                      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: "A unique identifier for the custom payment method\
                        \ of this transaction.  \n**Prerequisite**\n\n* The `transaction[payment_method]`\
                        \ is `custom`.\n"
                      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: "The status of this transaction.\n\n* late_failure\
                        \ -\n  Indicates that a previously successful payment transaction\
                        \ has failed due to a late failure notification from the payment\
                        \ gateway. Common reasons include insufficient funds or a\
                        \ closed bank account.\n  Pass the `transaction[error_code]`\
                        \ and `transaction[error_text]` to identify the reason for\
                        \ failure.\n  The `amount_due` on the invoice or the customer's\
                        \ `excess_payments` balance is not affected when this status\
                        \ is set.\n* failure -\n  Transaction failed. Pass the `transaction[error_code]`\
                        \ and `transaction[error_text]` to identify the reason for\
                        \ failure.\n  The `amount_due` on the invoice or the customer's\
                        \ `excess_payments` balance is not affected when this status\
                        \ is set.\n* success -\n  The transaction was successful.\
                        \  \n  **Impacts**\n\n  * The `amount_due` on the invoice\
                        \ is decreased by the `transaction[amount]`.\n  * If the `transaction[amount]`\
                        \ is greater than the `amount_due`, the excess amount is added\
                        \ to the customer's [`excess_payments`](/docs/api/customers/customer-object#excess_payments)\
                        \ balance.\n"
                      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 for the transaction failure. This is\
                        \ typically set by the payment gateway when a transaction\
                        \ fails.  \n**Prerequisite**\n\n* The `transaction[status]`\
                        \ is `failure` or `late_failure`.\n"
                      maxLength: 100
                      example: null
                    error_text:
                      type: string
                      deprecated: false
                      description: "Error message for transaction failure. This is\
                        \ typically set by the payment gateway when a transaction\
                        \ fails.  \n**Prerequisite**\n\n* The `transaction[status]`\
                        \ is `failure` or `late_failure`.\n"
                      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: |
                      Resource object representing invoice
                  transaction:
                    $ref: "#/components/schemas/Transaction"
                    description: |
                      Resource object representing transaction
                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:
      tags:
      - invoices
      summary: Delete an invoice
      description: "Deletes the specified invoice.\n\n#### Void the invoice\n\nIf\
        \ the invoice was generated incorrectly, [void](/docs/api/invoices/void-an-invoice)\
        \ it instead of deleting it. Voiding preserves the audit trail and allows\
        \ for future reference and compliance without removing the original record.\n\
        \n#### Regenerate or import an invoice\n\n* If the invoice is for the current\
        \ term of a subscription, you may regenerate it using the [Regenerate an invoice\
        \ API](/docs/api/subscriptions/regenerate-an-invoice).\n* If the invoice is\
        \ not for the current term of a subscription, you may import it using the\
        \ [Import an invoice API](/docs/api/invoices/import-invoice) or the UI [bulk\
        \ import](https://www.chargebee.com/docs/2.0/bulk-operations.html#overview_available-bulk-operations)\
        \ action.  \n\n### Prerequisites \\& Constraints\n\n* The invoice should not\
        \ have any [`linked_payments`](/docs/api/invoices/invoice-object#linked_payments)\
        \ with `txn_status` as `success` or `in_progress`.\n* The `amount_adjusted`\
        \ on the invoice should be zero.\n* The invoice should not have any [`applied_credits`](/docs/api/invoices/invoice-object#applied_credits)\
        \ with `cn_status` as `refunded` or `refund_due`.\n* The invoice should not\
        \ have any [`issued_credit_notes`](/docs/api/invoices/invoice-object#issued_credit_notes)\
        \ with `cn_status` as `refunded` or `refund_due`.\n* The invoice should not\
        \ have any [`linked_taxes_withheld`](/docs/api/invoices/invoice-object#linked_taxes_withheld).\n\
        * The invoice must not belong to a [gift subscription](/docs/api/gifts). \
        \ \n\n### Impacts\n\n**Invoices**  \n* The invoice is marked as `deleted`\
        \ = `true` and can only be retrieved using the [List invoices API](/docs/api/invoices/list-invoices)\
        \ by using the parameter `include_deleted=true`.\n* If the invoice is the\
        \ first invoice for a subscription or customer (`invoice.first_invoice` =\
        \ `true`), the next invoice generated for the subscription or customer is\
        \ marked as the first invoice.  \n**Subscription**  \n* If the invoice is\
        \ for the current term of a subscription and the subscription is changed later\
        \ with [proration](/docs/api/subscriptions/update-subscription-for-items#prorate)\
        \ enabled, no prorated credits are issued.  \n**Usages**  \n* Deleting an\
        \ invoice permanently deletes all associated [usages](/docs/api/usages). To\
        \ regenerate the data, [add](/docs/api/usages/create-a-usage) or [bulk import](https://www.chargebee.com/docs/2.0/bulk-operations.html#overview_available-bulk-operations)\
        \ usages and then regenerate the invoice.  \n**Usage Events**  \n* Deleting\
        \ an invoice does **not** delete the associated [`usage_event`](/docs/api/usage_events)\
        \ resources.  \n**Integrations**  \n* Verify the impacts of deleting an invoice\
        \ on your [accounting](https://www.chargebee.com/docs/billing/2.0/integrations/finance-integration-index)\
        \ integrations.  \n\n### Implementation Notes\n\nBefore calling this API,\
        \ ensure the following:\n\n* [Remove](/docs/api/invoices/remove-payment-from-an-invoice)\
        \ any `linked_payments` with `txn_status` as `success` or `in_progress`.\n\
        * [Remove](/docs/api/invoices/remove-credit-note-from-an-invoice) the following\
        \ credits:\n  * any `applied_credits` with `cn_status` as `refunded` or `refund_due`\n\
        \  * any `issued_credit_notes` with `cn_status` as `refunded` or `refund_due`\n\
        \  * any `adjustment_credit_notes` with `cn_status` as `adjusted`\n* [Remove](/docs/api/invoices/remove-tax-withheld-for-an-invoice)\
        \ any `linked_taxes_withheld`.\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing invoice
                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:
      tags:
      - invoices
      summary: Import invoice
      description: "Imports an invoice into Chargebee Billing.\n\nUse this API to\
        \ import invoices from your other billing or accounting system into Chargebee\
        \ Billing. You can import both current-term and historical invoices.  \n**Caution:\
        \ Importing current-term invoices**\nTo ensure accurate [proration](https://www.chargebee.com/docs/billing/2.0/subscriptions/proration#proration)\
        \ for any changes to the subscription in the current term, import only one\
        \ current-term invoice. Chargebee considers only the first imported invoice\
        \ for the current term when calculating proration. If you have multiple invoices\
        \ for the current term in the source system, consolidate them into a single\
        \ invoice before importing it into Chargebee.  \n\n### Impacts\n\n**RevenueStory**\
        \  \n* You must run the [MRR History Builder](https://www.chargebee.com/docs/billing/2.0/reports-and-analytics/monthly-recurring-revenue#how-are-the-metrics-calculated-from-historical-data)\
        \ to update Revenue Story metrics after importing invoices. [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 do this.  \n**Accounting Integrations**  \n* Chargebee Billing [accounting\
        \ integrations](https://www.chargebee.com/docs/billing/2.0/integrations/finance-integration-index)\
        \ sync imported invoices, unless you disable them from syncing.  \n\n### Implementation\
        \ Notes\n\n* If discounts are present on the invoice, then the following parameters\
        \ must be passed:\n  * `discounts[entity_type][]`\n  * `discounts[amount][]`\n\
        \  * `discounts[line_item_id][i]` if `discounts[entity_type][i]` is `item_level_coupon`\
        \ or `document_level_coupon`.\n* If taxes are present on the invoice, then\
        \ the following parameters must be passed:\n  * `taxes[name][]`\n  * `taxes[rate][]`\n\
        \  * `line_items[tax*_name][]`\n  * `line_items[tax*_amount][]`\n  * `line_items[is_partial_tax_applied][]`\
        \ and `line_items[taxable_amount][]` when tax applies to only a portion of\
        \ the line item amount. When `line_items[is_partial_tax_applied][]` is `true`,\
        \ `line_items[taxable_amount][]` is required.\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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
              properties:
                id:
                  type: string
                  deprecated: false
                  description: |
                    The invoice ID (also known as the invoice number). Must be unique so that it does not conflict with any existing `invoice.id`.
                  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](/docs/api/customers) resource to which this invoice belongs.
                  maxLength: 50
                  example: null
                subscription_id:
                  type: string
                  deprecated: false
                  description: |
                    The ID of the [subscription](/docs/api/subscriptions) resource to which this invoice belongs.
                  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.).

                    * zero_rated - If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item
                    * 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.
                    * tax_not_configured_external_provider - If the tax is not configured for the country in 3rd party tax provider.
                    * 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.)
                    * high_value_physical_goods - 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
                    * product_exempt - If the Plan or Addon is marked as Tax exempt
                    * region_non_taxable - 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
                    * zero_value_item - 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.
                  enum:
                  - zero_rated
                  - id_exempt
                  - customer_exempt
                  - region_non_taxable
                  - product_exempt
                  - export
                  - high_value_physical_goods
                  - zero_value_item
                  - tax_not_configured_external_provider
                  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: |
                    An overridden value for the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number).
                    Only applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)

                    `country`
                    as `XI`
                    (which is **United Kingdom - Northern Ireland**
                    ).

                    When you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)
                    in 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)
                    the Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)

                    `country`
                    as `XI`.
                    That's the code for **United Kingdom - Northern Ireland** .
                    The first two characters of the VAT number in such a case is
                    `XI`
                    by default. However, if the VAT number was registered in UK, the value should be `GB`.
                    Set
                    `vat_number_prefix`
                    to `GB`
                    for such cases.
                  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](/docs/api/invoices/invoice-object#round_off_amount).
                  maximum: 99
                  minimum: -99
                  example: null
                status:
                  type: string
                  deprecated: false
                  description: |
                    Current status of this invoice.

                    * not_paid - Indicates the payment is not made and all attempts to collect is failed.
                    * voided - Indicates a voided invoice.
                    * 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.
                    * pending -
                      The [invoice](/docs/api/invoices/invoice-object#status) is yet to be closed (sent for payment collection). An invoice is generated with this `status` when it has line items that belong to items that are `metered` or when the `subscription.create_pending_invoices`attribute is set to `true`.
                      The [invoice](/docs/api/v2/pcv-1/invoices/invoice-object#status) is yet to be closed (sent for payment collection). All invoices are generated with this `status` when [Metered Billing](https://www.chargebee.com/docs/1.0/metered_billing.html) is enabled for the site.
                    * payment_due - Indicates the payment is not yet collected and is being retried as per retry settings.
                  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: |
                    The due date of the invoice.
                  example: null
                net_term_days:
                  type: integer
                  format: int32
                  default: 0
                  deprecated: false
                  description: |
                    The number of days from [`invoice.date`](/docs/api/invoices/invoice-object#date) until payment for the invoice is due.
                  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
                paid_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    Timestamp when the invoice was paid. Applicable only when `status` is `paid`.
                  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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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](/docs/api/subscriptions)\
                        \ resource to which this line item belongs.  \n**Note**\n\n\
                        * When multiple different `line_items.subscription_id[]` are\
                        \ specified, this indicates a [consolidated invoice](https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/consolidated-invoicing).\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    description:
                      type: array
                      description: |
                        Description for this line item. Append `- prorated charges` to the description if the line item is prorated. This will prevent it from being considered for [MRR](/docs/api/subscriptions/subscription-object#mrr) calculations.
                      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: |
                        [Quantity of the recurring item](/docs/api/invoices/invoice-object#line_items_quantity) which is represented by this line item. For `metered` line items, this value is updated from [usages](/docs/api/usages) once when the invoice is generated as `pending` and finally when the invoice is [closed](/docs/api/invoices/close-a-pending-invoice).
                        [Quantity of the recurring item](/docs/api/v2/pcv-1/invoices/invoice-object#line_items_quantity) which is represented by this line item.
                      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: |
                        The decimal representation of the unit amount of the `line_item`.
                        The value is in major units of the currency. Returned when the `line_item`
                        is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      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 line_item. Returned when the `line_item`
                        is quantity-based and [multi-decimal pricing](/docs/api/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 amount for the `line_item`
                        , in major units of the currency. Typically equals to `unit_amount_in_decimal`
                        x `quantity_in_decimal`.
                        Returned when [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      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.

                          * plan_item_price - Indicates that this line item corresponds to an `item_price` of `item_type` `plan`.
                          * addon_item_price - Indicates that this line item corresponds to an `item_price` of `item_type` `addon`.
                          * charge_item_price - Indicates that this line item corresponds to an `item_price` of `item_type` `charge`.
                          * adhoc - Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case
                        enum:
                        - adhoc
                        - plan_item_price
                        - addon_item_price
                        - charge_item_price
                        example: null
                      example: null
                    entity_id:
                      type: array
                      description: |
                        The ID of the entity that this line item corresponds to.
                      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
                    is_partial_tax_applied:
                      type: array
                      description: "Indicates whether tax is applied only to a portion\
                        \ of the line item amount.  \n**Constraints**\n\n* Must not\
                        \ be provided when the line item has no taxes.\n"
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    taxable_amount:
                      type: array
                      description: "The portion of the line item amount, in cents,\
                        \ that is taxable.\nChargebee stores this on import so later\
                        \ credit notes tax this amount instead of the full line item\
                        \ amount.  \n**Required if**\n\n* `line_items[is_partial_tax_applied]`\
                        \ is `true`.  \n**Constraints**\n\n* Must not be provided\
                        \ when the line item has no taxes.\n"
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    proration_mode:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Proration mode for the line item.
                        enum:
                        - reset
                        - delta
                        - service_period_revision
                        - adjusted_term
                        example: null
                      example: null
                    created_at:
                      type: array
                      description: ""
                      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: |
                        If `id`
                        is not provided then our system will automatically generate a unique id.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          This attribute helps `type`
                          field in the API, specifies how to reconcile offline payments, and generate `payment_reference_number`
                          on invoices based on country-specific rules. Setting the `type`
                          field generates `payment_reference_number`
                          for the respective country and includes them on the invoice for correct reconciliation.

                          * swiss_reference - Switzerland based number calculated using the recursive MOD 10 algorithm for QR references, or the MOD 97 algorithm for ISO 11649 creditor references, based on the reference type.
                          * kid - The KID number (kundeidentifikasjon) in Norway is an abbreviation for "Customer identification". It is used to associate payments with the customer and invoice.
                          * fik - Denmark based number calculated using recursive MOD 10 algorithm.
                          * frn - The reference number printed on invoices in Finland is utilized by buyers for payment via bank transfer, facilitating the association of payments with invoices.
                          * ocr - 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.
                        enum:
                        - kid
                        - ocr
                        - frn
                        - fik
                        - swiss_reference
                        example: null
                      example: null
                    number:
                      type: array
                      description: |
                        If you have already generated a `payment_reference_number`
                        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 `/api/v2/invoices/payment_reference_numbers`
                        API.
                      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: |
                        The price of the tier if the charge model is a `stairtstep`
                        pricing , or the price of each unit in the tier if the charge model is `tiered`
                        /`volume`
                        pricing.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the `line_items.pricing_model`
                        is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the `line_items.pricing_model`
                        is `tiered`
                        , `volume`
                        or stairstep and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    quantity_used_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity purchased from this tier. Returned when the `line_item`
                        is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_amount_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for `line_item`.
                        The value is in major units of the currency. Returned when the `line_item`
                        is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      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: |
                        The unique id of the line item that this deduction is for.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    entity_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The type of deduction and the amount to which it is applied.

                          * item_level_coupon -
                            The deduction is due to a coupon applied to line item. The coupon `id`
                            is passed as `entity_id`
                            .
                          * item_level_discount -
                            The deduction is due to a [discount](/docs/api/discounts)
                            applied to a line item of the invoice. The discount `id`
                            is available as the `entity_id`.
                          * document_level_coupon -
                            The deduction is due to a coupon applied to the invoice `sub_total`.
                            The coupon id is passed as `entity_id`
                            .
                          * promotional_credits -
                            The deduction is due to a [promotional credit](/docs/api/promotional_credits)
                            applied to the invoice.
                          * document_level_discount -
                            The deduction is due to a [discount](/docs/api/discounts)
                            applied to the invoice `sub_total`.
                            The discount `id`
                            is available as the `entity_id`.
                        enum:
                        - item_level_coupon
                        - document_level_coupon
                        - promotional_credits
                        - item_level_discount
                        - document_level_discount
                        example: null
                      example: null
                    entity_id:
                      type: array
                      description: |
                        When the deduction is due to a `coupon`
                        , then this is the `id`
                        of the coupon.
                      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.
                      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.\
                        \  \n**Impacts**\n\n* None. Although required, this parameter\
                        \ is not used by Chargebee.\n"
                      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
                      description: ""
                      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: |
                          Mode of payment

                          * check - Check
                          * bank_transfer - Bank Transfer
                          * custom - Custom
                          * other - Payment Methods other than the above types
                          * cash - Cash
                        enum:
                        - cash
                        - check
                        - bank_transfer
                        - other
                        - custom
                        - tamara
                        - qpay
                        - blik
                        - fpx
                        - wero
                        - p24
                        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.

                          * plan_item_price - Indicates that this line item is based on plan Item Price
                          * coupon - Entity that represents a coupon.
                          * 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
                        enum:
                        - 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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      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: |
                      Resource object representing invoice
                  credit_note:
                    $ref: "#/components/schemas/CreditNote"
                    description: |
                      Resource object representing credit_note
                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:
      tags:
      - invoices
      summary: Resume dunning for invoice
      description: |
        Immediately resumes [dunning](https://www.chargebee.com/docs/payments/2.0/dunning-v2.html) for the specified invoice.

        * If the current time is within the dunning period for the invoice, Chargebee resumes any dunning [retries](https://www.chargebee.com/docs/payments/2.0/dunning-v2.html) and [email notifications](https://www.chargebee.com/docs/payments/2.0/dunning-v2.html#dunning-email-notifications) that remain after the pause period, and not attempt the retries or notifications that were canceled during the pause period.
        * If the current time is after the dunning period for the invoice, the [final action](https://www.chargebee.com/docs/payments/2.0/dunning-v2.html) configured in Billing is initiated for the invoice and, if applicable, for the subscription.

        #### Prerequisites

        This operation is only permitted for an invoice with a [status](/docs/api/invoices/invoice-object#status) of `payment_due` and for which dunning was previously [paused](/docs/api/invoices/pause-dunning-for-invoice).
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing invoice
                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:
      tags:
      - invoices
      summary: Record tax withheld for an invoice
      description: |
        Records [tax_withheld](/docs/api/tax_withheld) by the customer against the invoice specified. This operation is allowed only when all of the following conditions are true:

        * Tax Amount Withheld is enabled.
        * The `invoice` does not have a `linked_taxes_withheld` record associated with it already.
        * `invoice.amount_due` is greater than zero.
        * `invoice.status` is one of the following: `payment_due`, `not_paid`, or `posted`.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                        The amount withheld by the customer as tax from the invoice. This must not exceed [invoice.amount_due](/docs/api/invoices/invoice-object#amount_due).
                        The unit depends on the [type of currency](/docs/api/getting-started).
                      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: |
                      Resource object representing invoice
                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:
      tags:
      - invoices
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing invoice
                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:
      tags:
      - invoices
      summary: Remove tax withheld for an invoice
      description: |
        Removes a [linked_taxes_withheld](/docs/api/invoices/invoice-object#linked_taxes_withheld) record from the `invoice` specified. This operation is allowed only when all of the following conditions are true:

        * [invoice.status](/docs/api/invoices/invoice-object#status) is one of the following: `payment_due`, `not_paid`, or `posted`.
        * There are no [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes) associated with the invoice.
        * There are no [issued_credit_notes](/docs/api/invoices/invoice-object#issued_credit_notes) associated with the invoice.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                        An auto-generated unique identifier for the tax withheld. The value starts with the prefix `tax_wh_`.
                        For example, `tax_wh_16BdDXSlbu4uV1Ee6`
                        .
                      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: |
                      Resource object representing invoice
                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:
      tags:
      - invoices
      summary: List payment reference numbers
      description: |
        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 `invoice_id`
        or the `payment_reference_number[number]`
        to retrieve the PRN.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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:
            in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
            is:
              type: string
              minLength: 1
              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:
                in:
                  type: string
                  pattern: "^\\[(.*)(,.*)*\\]$"
                  example: null
                is:
                  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:
                        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:
      tags:
      - invoices
      summary: Collect payment for an invoice
      description: "Collects a specified amount of payment for an invoice, via a specified\
        \ online payment method.  \n\n#### Offline payments\n\nWhen there is no payment\
        \ method available, and if you wish to record an offline payment, use the\
        \ [Record an offline payment API](/docs/api/invoices/record-an-invoice-payment)\
        \ instead.  \n\n### Prerequisites \\& Constraints\n\n* The invoice `status`\
        \ must be `payment_due`, `posted`, or `not_paid`.\n* The invoice `channel`\
        \ must not be `app_store` or `play_store`.\n* The invoice's [`amount_to_collect`](/docs/api/invoices/invoice-object#amount_to_collect)\
        \ must be greater than 0.\n* A valid `payment_source` must be associated with\
        \ the customer.  \n\n### Impacts\n\n**Invoice**  \n* The invoice `status`\
        \ changes to `paid` if the `amount_due` on the invoice becomes zero because\
        \ of this payment. Otherwise, the `status` remains unchanged.  \n**Payment\
        \ Schedules**  \nIf a [`payment_schedule`](/docs/api/payment_schedules) exists\
        \ for the invoice:\n\n* For a successful payment, Chargebee reduces [`schedule_entries[].amount`](/docs/api/payment_schedules/payment_schedule-object#schedule_entries)\
        \ for the entries the payment covers. An entry whose remaining amount reaches\
        \ `0` is marked `paid`.\n* Chargebee adds the payment to [`reference_transactions[]`](/docs/api/payment_schedules/payment_schedule-object#reference_transactions),\
        \ including failed and in-progress attempts with `applied_amount` `0`.  \n\
        \n#### Related APIs\n\n[Record an offline payment](/docs/api/invoices?prod_cat_ver=2#record_an_invoice_payment)\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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.  \n**Constraints**\n\n* Must\
                    \ be less than or equal to the `invoice.amount_to_collect` or\
                    \ the `transaction.amount` if `authorization_transaction_id` is\
                    \ passed, whichever is lesser.  \n**Default value**\n\n* When\
                    \ not passed, then `invoice.amount_to_collect` is assumed.\n"
                  minimum: 1
                  example: null
                authorization_transaction_id:
                  type: string
                  deprecated: false
                  description: "The `id` of the transaction that is used to authorize\
                    \ the payment. (The transaction's [`type`](/docs/api/transactions/transaction-object#type)\
                    \ must be `authorization`.)  \n**Required if**\n\n* `payment_source_id`\
                    \ is not passed.  \n**Prerequisites**\n\n* The `transaction.fraud_flag`\
                    \ must be `safe`.  \n**Constraints**\n\n* Applicable only for\
                    \ card payments via [Stripe](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/stripe).\n"
                  maxLength: 40
                  example: null
                payment_source_id:
                  type: string
                  deprecated: false
                  description: "The `id` of a valid `payment_source` associated with\
                    \ the customer.  \n**Required if**\n\n* `authorization_transaction_id`\
                    \ is not passed.\n"
                  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 initiator of this payment request. Sending this information can improve the success rate of the payment at the gateway.

                    * merchant - The payment was initiated by you (the merchant).
                    * customer - The payment was initiated by your 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: |
                      Resource object representing invoice
                  transaction:
                    $ref: "#/components/schemas/Transaction"
                    description: |
                      Resource object representing transaction
                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:
      tags:
      - invoices
      summary: Sync usages
      description: |
        Updates the [`quantity`](/docs/api/invoices/invoice-object#line_items_quantity) for `metered` [`line_items`](/docs/api/invoices/invoice-object#line_items) of an invoice to reflect the latest [usage](/docs/api/usages) data.
        **Note:** This operation is done automatically while [closing](/docs/api/invoices/close-a-pending-invoice) the invoice.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing invoice
                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:
      tags:
      - invoices
      summary: Refund an invoice
      description: "Refunds online payments or online refundable credit notes applied\
        \ to an invoice.\n\nIf multiple [transactions](/docs/api/invoices/invoice-object#linked_payments)\
        \ or [credit note allocations](/docs/api/invoices/invoice-object#applied_credits)\
        \ are associated with the invoice, the refund can be processed only for one\
        \ transaction or allocation at a time. The refund amount is returned to the\
        \ customer through the [`payment_source`](/docs/api/payment_sources) associated\
        \ with the transaction.\n\nFor recording offline refunds, including those\
        \ for [`linked_taxes_withheld`](/docs/api/invoices/invoice-object#linked_taxes_withheld),\
        \ use the [Record refund for an invoice](/docs/api/invoices/record-refund-for-an-invoice)\
        \ API.  \n\n### Prerequisites \\& Constraints\n\n* The invoice must have a\
        \ [refundable amount](/docs/api/invoices/invoice-object#refundable-amount)\
        \ derived from online transactions.\n* There must be no `linked_payments`\
        \ with a status of `in-progress`.\n* Partial refunds can be processed only\
        \ if the associated payment gateway supports partial refund operations.\n\
        * Ensure that all parameter-level requirements are met.  \n\n### Impacts\n\
        \n**Invoice**  \n* The invoice status does **not** change after this operation.\
        \  \n**Credit note**  \n* A refundable [credit note](/docs/api/credit_notes)\
        \ is created for the invoice to capture the refund details.  \n\n### Implementation\
        \ Notes\n\nBefore calling this API, ensure the following:\n\n* The invoice\
        \ must have a refundable amount derived from online transactions. The refundable\
        \ amount is calculated as: `linked_payments[].amount` for online payments\
        \ + `applied_credits[].applied_amount` - `issued_credit_notes[].cn_total`\n\
        * There must be no `linked_payments` with a status of `in-progress`.\n* All\
        \ parameter-level requirements are met.  \n\n#### Related APIs\n\n[Record\
        \ refund for an invoice](/docs/api/invoices?prod_cat_ver=2#record_refund_for_an_invoice)\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: "The amount to be refunded.  \n**Constraints**\n\n\
                    * If multiple [transactions](/docs/api/invoices/invoice-object#linked_payments)\
                    \ or [credit note allocations](/docs/api/invoices/invoice-object#applied_credits)\
                    \ are associated with the invoice, the refund can be processed\
                    \ only for one transaction or allocation at a time.\n* Offline\
                    \ refunds, including those for [`linked_taxes_withheld`](/docs/api/invoices/invoice-object#linked_taxes_withheld),\
                    \ cannot be refunded via this operation. Use the [Record refund\
                    \ for an invoice](/docs/api/invoices/record-refund-for-an-invoice)\
                    \ API instead.  \n**Default behavior**\n\n* If not specified,\
                    \ the total refundable amount for this invoice derived from online\
                    \ transactions is implied. The refundable amount is calculated\
                    \ as: (the total amount paid on the invoice via online payments)\
                    \ + (allocations on the invoice from refundable credit notes that\
                    \ were created from online payments) - (any amount already refunded\
                    \ from the invoice).\n"
                  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
                        * other - Can be set when none of the above reason codes are applicable
                        * waiver - Waiver
                        * order_cancellation - Order Cancellation
                        * order_change - Order Change
                        * service_unsatisfactory - Service Unsatisfactory
                      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: |
                      Resource object representing invoice
                  transaction:
                    $ref: "#/components/schemas/Transaction"
                    description: |
                      Resource object representing transaction
                  credit_note:
                    $ref: "#/components/schemas/CreditNote"
                    description: |
                      Resource object representing credit_note
                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:
      tags:
      - invoices
      summary: Record refund for an invoice
      description: "Record a full or partial offline refund for an invoice.\n\nUse\
        \ this API to record refunds processed outside Chargebee (for example, directly\
        \ through a payment gateway or via offline methods such as bank transfers\
        \ or checks) so you can reconcile them in Chargebee.\n\n**Important:** This\
        \ API does not process actual refunds for online payments or return money\
        \ to customers through the payment gateway. To process refunds for online\
        \ payments and return money to customers, use the [Refund an invoice](/docs/api/invoices/refund-an-invoice)\
        \ API instead.  \n\n### Prerequisites \\& Constraints\n\nThe invoice must\
        \ have a [refundable amount](/docs/api/invoices/invoice-object#refundable-amount).\
        \ (See Implementation Notes for details.)  \n\n### Impacts\n\n**Credit note**\
        \  \nChargebee creates a `refundable` [credit note](/docs/api/credit_notes/credit-note-object)\
        \ with [`status`](/docs/api/credit_notes/credit_note-object#status) set to\
        \ `refunded`.  \n**Transactions**  \nChargebee records the refunds by creating\
        \ transactions of [`type`](/docs/api/transactions/transaction-object#type)\
        \ `refund` and links them to the credit note. The refund transactions are\
        \ recorded in the following order:\n\n1. [`linked_payments`](/docs/api/invoices/invoice-object#linked_payments)\
        \ for offline transactions. This is recorded as [`linked_refunds[]`](/docs/api/credit_notes/credit_note-object#linked_refunds)\
        \ in the credit note.\n2. [`linked_taxes_withheld`](/docs/api/invoices/invoice-object#linked_taxes_withheld)\
        \ (if available). This is recorded as [`linked_tax_withheld_refunds[]`](/docs/api/credit_notes/credit_note-object#linked_tax_withheld_refunds)\
        \ in the credit note.\n3. `linked_payments` for online transactions (after\
        \ offline payments and taxes withheld are exhausted). This is recorded as\
        \ [`linked_refunds[]`](/docs/api/credit_notes/credit_note-object#linked_refunds)\
        \ in the credit note.\n\n**Example**\n\nConsider an invoice with the following\
        \ payments and tax withheld:\n\n* Offline payments: $30\n* Online payments:\
        \ $20\n* Tax withheld: $5\n\nWhen you record a refund of $40, Chargebee allocates\
        \ the refund as follows:\n\n* Refund against offline payments: $30\n* Refund\
        \ against tax withheld: $5\n* Refund against online payments: $5  \n\n###\
        \ Implementation Notes\n\nBefore calling this API, perform the following checks:\n\
        \n* The invoice must have a [refundable amount](/docs/api/invoices/invoice-object#refundable-amount).\n\
        * Ensure the `transaction[date]` is on or after the invoice date and not in\
        \ the future.\n* Include the `transaction[amount]` parameter to specify the\
        \ refund amount. If you omit this parameter, the system records the entire\
        \ refundable amount as refunded.\n* If [reason codes](https://www.chargebee.com/docs/billing/2.0/site-configuration/reason-codes#managing-reason-codes-for-credit-notes)\
        \ are mandatory in Chargebee Billing, include the `credit_note[create_reason_code]`\
        \ parameter with a value from the configured list of codes.\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                        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.

                        **Note:**
                        Any [linked_taxes_withheld](/docs/api/invoices/invoice-object#linked_taxes_withheld)
                        associated with the invoice can also be recorded as refunded via this operation.
                      minimum: 0
                      example: null
                    payment_method:
                      type: string
                      deprecated: false
                      description: |
                        The payment method of this transaction

                        * cash - Cash
                        * other - Payment Methods other than the above types
                        * custom - Custom
                        * check - Check
                        * bank_transfer - Bank Transfer
                        * chargeback -
                          Only applicable for a transaction of [type](/docs/api/transactions/transaction-object#type)
                          = `refund`.
                          This value is set by Chargebee when an automated [chargeback](https://www.chargebee.com/docs/chargeback.html#chargeback-process)
                          occurs. You can also set this explicitly when [recording a refund](/docs/api/transactions/record-an-offline-refund)
                          .
                      enum:
                      - cash
                      - check
                      - chargeback
                      - bank_transfer
                      - other
                      - custom
                      - tamara
                      - qpay
                      - blik
                      - fpx
                      - wero
                      - p24
                      example: null
                    reference_number:
                      type: string
                      deprecated: false
                      description: |
                        The reference number for this transaction. For example, the check number when [payment_method](/docs/api/transactions/transaction-object#payment_method)
                        = `check`
                        .
                      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\]

                        * product_unsatisfactory - Product Unsatisfactory
                        * chargeback - Can be set when you are recording your customer Chargebacks
                        * service_unsatisfactory - Service Unsatisfactory
                        * other - Can be set when none of the above reason codes are applicable
                        * waiver - Waiver
                        * order_cancellation - Order Cancellation
                        * order_change - Order Change
                      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: |
                      Resource object representing invoice
                  transaction:
                    $ref: "#/components/schemas/Transaction"
                    description: |
                      Resource object representing transaction
                  credit_note:
                    $ref: "#/components/schemas/CreditNote"
                    description: |
                      Resource object representing credit_note
                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:
      tags:
      - invoices
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing download
                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:
      tags:
      - invoices
      summary: Download e-invoice
      description: "Download the e-invoice in both XML and PDF formats. The response\
        \ consists of a `download` object for each format. The XML format follows\
        \ the [structure as per Peppol BIS Billing v3.0](https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/tree/).\
        \  \n**Note**\n\n* You can only download e-invoices when their `status` is\
        \ `success`.\n* 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 [cbc:EmbeddedDocumentBinaryObject](https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-AdditionalDocumentReference/cac-Attachment/cbc-EmbeddedDocumentBinaryObject/),\
        \ which is the Base64-encoded version of the PDF.\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
                  downloads:
                    type: array
                    description: |
                      Resource object representing download
                    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: []
  /payment_schedules:
    get:
      tags:
      - payment_schedules
      summary: List payment schedules
      description: |
        Returns a list of payment schedules that match **all** the specified filter conditions. The list is sorted by `updated_at` in descending order. Use `limit` and `offset` to paginate through the results.

        Use `invoice_id` to restrict results to one or more invoices. To fetch schedules for a single invoice by path, use the [Retrieve payment schedules for an invoice](/docs/api/invoices/retrieve-payment-schedules-for-an-invoice) API.
      operationId: list_payment_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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: invoice_id
        in: query
        description: |
          optional, string filter

          The invoice number of the invoice this payment schedule belongs to.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

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

          An auto-generated unique identifier for the payment schedule.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *id\[is\] = "ps_123"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: ps_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: 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\] = "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:
                        payment_schedule:
                          $ref: "#/components/schemas/PaymentSchedule"
                          description: Resource object representing payment_schedule
                      required:
                      - payment_schedule
                      example: null
                    example: null
                  next_offset:
                    type: string
                    description: |
                      This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.
                    maxLength: 1000
                    example: null
                required:
                - list
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /credit_notes/{credit-note-id}/record_refund:
    post:
      tags:
      - credit_notes
      summary: Record refund for a credit note
      description: "Records a refund for a refundable credit note.\n\nThis API does\
        \ not process an actual refund for online payments by returning money to customers.\n\
        \nUse this API to record refunds processed outside Chargebee (for example,\
        \ directly through a payment gateway or via offline methods such as bank transfers\
        \ or checks) so you can reconcile them in Chargebee.\n\nTo process refunds\
        \ via Chargebee for online payments and automatically return money to customers,\
        \ use the [Refund a credit note](/docs/api/credit_notes/refund-a-credit-note)\
        \ API instead.  \n\n### Prerequisites \\& Constraints\n\n* The credit note\
        \ [`type`](/docs/api/credit_notes/credit_note-object#type) must be `refundable`.\n\
        * The credit note [`status`](/docs/api/credit_notes/credit_note-object#status)\
        \ must be `refund_due`.  \n\n### Impacts\n\n**Transactions**  \nChargebee\
        \ records the refunds by creating transactions of [`type`](/docs/api/transactions/transaction-object#type)\
        \ `refund` and links them to the credit note. The refund transactions are\
        \ recorded in the following order:\n\n1. [`linked_payments`](/docs/api/invoices/invoice-object#linked_payments)\
        \ of the invoice associated with the credit note. This is recorded as [`linked_refunds[]`](/docs/api/credit_notes/credit_note-object#linked_refunds)\
        \ in the credit note.\n2. [`linked_taxes_withheld`](/docs/api/invoices/invoice-object#linked_taxes_withheld)\
        \ (if available). This is recorded as [`linked_tax_withheld_refunds[]`](/docs/api/credit_notes/credit_note-object#linked_tax_withheld_refunds)\
        \ in the credit note.  \n\n### Implementation Notes\n\nBefore using this API,\
        \ ensure:\n\n* The credit note [`type`](/docs/api/credit_notes/credit_note-object#type)\
        \ is `refundable`.\n* The credit note [`status`](/docs/api/credit_notes/credit_note-object#status)\
        \ is `refund_due`.\n* If [reason codes](https://www.chargebee.com/docs/billing/2.0/site-configuration/reason-codes#managing-reason-codes-for-credit-notes)\
        \ are mandatory in Chargebee Billing, include the `refund_reason_code` parameter\
        \ with a value from the configured list of codes.\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
                      description: |
                        The payment transaction ID.
                      maxLength: 40
                      example: null
                    amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        The amount to be recorded as refunded. If not specified, the entire [refundable amount](/docs/api/credit_notes/credit_note-object#amount_available)
                        for this `credit_note`
                        is assumed.
                      minimum: 0
                      example: null
                    payment_method:
                      type: string
                      deprecated: false
                      description: |
                        The payment method of this transaction

                        * cash - Cash
                        * other - Payment Methods other than the above types
                        * custom - Custom
                        * check - Check
                        * bank_transfer - Bank Transfer
                        * chargeback -
                          Only applicable for a transaction of [type](/docs/api/transactions/transaction-object#type)
                          = `refund`.
                          This value is set by Chargebee when an automated [chargeback](https://www.chargebee.com/docs/chargeback.html#chargeback-process)
                          occurs. You can also set this explicitly when [recording a refund](/docs/api/transactions/record-an-offline-refund)
                          .
                      enum:
                      - cash
                      - check
                      - chargeback
                      - bank_transfer
                      - other
                      - custom
                      - tamara
                      - qpay
                      - blik
                      - fpx
                      - wero
                      - p24
                      example: null
                    reference_number:
                      type: string
                      deprecated: false
                      description: |
                        The reference number for this transaction. For example, the check number when [payment_method](/docs/api/transactions/transaction-object#payment_method)
                        = `check`
                        .
                      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: |
                      Resource object representing credit_note
                  transaction:
                    $ref: "#/components/schemas/Transaction"
                    description: |
                      Resource object representing transaction
                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:
      tags:
      - credit_notes
      summary: Import credit note
      description: "Imports a credit note into Chargebee Billing. This endpoint allows\
        \ you to import a credit note from external systems, such as accounting software,\
        \ into Chargebee.\n\nUse this operation during data migration or reconciliation\
        \ to ensure historical credits are represented in the system. The credit note\
        \ is linked to a reference [invoice](/docs/api/invoices) and can be allocated\
        \ to other invoices or recorded as refunded to the customer.  \n\n### Impacts\n\
        \n**Credit Note**  \nThe credit note's [`billing_address`](/docs/api/credit_notes/credit-note-object#credit_note_billing_address),\
        \ [`shipping_address`](/docs/api/credit_notes/credit-note-object#credit_note_shipping_address),\
        \ and [`vat_number`](/docs/api/credit_notes/credit-note-object#credit_note_vat_number)\
        \ are copied from the reference invoice.  \n**Invoices**  \n\n##### Reference\
        \ invoice\n\n* See [Impact on reference invoice](/docs/api/credit_notes/credit-note-object#ref-invoice-impact).\n\
        \n##### Other invoices\n\n* If `allocations[]` are provided, then for each\
        \ allocated invoice:\n  * the invoice's `amount_due` decreases by the allocated\
        \ amount\n  * the invoice `status` changes to `paid` if the `amount_due` becomes\
        \ zero\n* an [applied credit](/docs/api/invoices/invoice-object#applied_credits)\
        \ record is created to track the allocation.  \n**Transactions**  \nIf `linked_refunds[]`\
        \ are provided, then for each refund provided, a [`transaction`](/docs/api/transactions/transaction-object)\
        \ of `type` `refund` is created with `status` set to `success`.\n"
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
              properties:
                id:
                  type: string
                  deprecated: false
                  description: "The unique identifier for the credit note (credit\
                    \ note number).  \n**Constraints**\n\n* Must not conflict with\
                    \ existing credit note numbers in your Chargebee Billing site.\n\
                    * Must not conflict with future credit note numbers that your\
                    \ Chargebee Billing site may [generate](https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/invoice-numbering).\n"
                  maxLength: 50
                  example: null
                customer_id:
                  type: string
                  deprecated: false
                  description: "The unique identifier of the customer for whom the\
                    \ credit note is created.  \n**Required if**\n\n* `subscription_id`\
                    \ is not provided.  \n**Constraints**\n\n* Must match the [customer](/docs/api/invoices/invoice-object#invoice_customer_id)\
                    \ of the `reference_invoice_id`.\n"
                  maxLength: 50
                  example: null
                subscription_id:
                  type: string
                  deprecated: false
                  description: "The unique identifier of the subscription for which\
                    \ this credit note is created.  \n**Required if**\n\n* `customer_id`\
                    \ is not provided.  \n**Constraints**\n\n* Must match the [subscription](/docs/api/invoices/invoice-object#invoice_subscription_id)\
                    \ of the `reference_invoice_id`.\n* Must not be provided if `line_items[subscription_id][]`\
                    \ is provided.\n"
                  maxLength: 50
                  example: null
                reference_invoice_id:
                  type: string
                  deprecated: false
                  description: |
                    The unique identifier of the invoice against which this credit note is issued. The invoice must already exist in your Chargebee Billing site.
                  maxLength: 50
                  example: null
                type:
                  type: string
                  deprecated: false
                  description: "The credit note type. Determines how the credit note\
                    \ can be used. [Learn more](/docs/api/credit_notes/credit-note-object#credit_note_types)\
                    \ about credit note types.\n\n* refundable - Refundable credit\
                    \ note.\n* store -\n  Store credit note.  \n  **Constraints**\n\
                    \n  * The `type` value `store` is not supported for this API operation.\n\
                    * adjustment - Adjustment credit note.\n"
                  enum:
                  - adjustment
                  - refundable
                  - store
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  description: "The currency code ([ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)\
                    \ format) for the credit note.  \n**Required if**\n\n* [Multi-currency\
                    \ pricing](https://www.chargebee.com/docs/billing/2.0/site-configuration/multi-currency-pricing)\
                    \ is enabled for the site and `customer_id` is provided.\n"
                  maxLength: 3
                  example: null
                create_reason_code:
                  type: string
                  deprecated: false
                  description: "The [reason code](https://www.chargebee.com/docs/billing/2.0/site-configuration/reason-codes#managing-reason-codes-for-credit-notes)\
                    \ for creating the credit note.  \n**Required if**\n\n* Reason\
                    \ codes are mandatory in Chargebee Billing.  \n**Constraints**\n\
                    \n* Must be a valid and enabled reason code from the list configured\
                    \ in Chargebee Billing.\n* The reason code can also be from **Refund\
                    \ Credit Note** reason codes.\n* The codes are case-sensitive.\n"
                  maxLength: 100
                  example: null
                date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: "The date when the credit note was issued.  \n**Constraints**\n\
                    \n* Must be a date in the past.\n* Must be after the [`date`](/docs/api/invoices/invoice-object#invoice_date)\
                    \ of the reference invoice.\n"
                  example: null
                status:
                  type: string
                  deprecated: false
                  description: "The status of the credit note. Determines the current\
                    \ state of the credit note and how it can be used.  \n**Default\
                    \ value**\n\n* `adjusted` if `type` is `adjustment`.\n* if `type`\
                    \ is `refundable`:\n  * `refunded` if the credit note `total`\
                    \ is equal to the sum of `linked_refunds[amount][]` plus the sum\
                    \ of `allocations[allocated_amount][]`.\n  * `refund_due` otherwise.\n\
                    \n* refund_due -\n  The credits are yet to be used or have been\
                    \ partially used.  \n  **Constraints**\n\n  * Must only be set\
                    \ when `type` is `refundable`.\n  * The credit note `total` must\
                    \ be greater than the sum of `linked_refunds[amount][]` plus the\
                    \ sum of `allocations[allocated_amount][]`.\n* refunded -\n  The\
                    \ entire credit note amount has been used (either allocated to\
                    \ invoices or refunded).  \n  **Constraints**\n\n  * Must only\
                    \ be set when `type` is `refundable`.\n  * Requires `linked_refunds[]`\
                    \ and/or `allocations[]` to be provided.\n  * The sum of `linked_refunds[amount][]`\
                    \ plus the sum of `allocations[allocated_amount][]` must equal\
                    \ the credit note `total`.\n* voided -\n  The credit note has\
                    \ been cancelled.  \n  **Constraints**\n\n  * `linked_refunds[]`\
                    \ and `allocations[]` must not be provided when `status` is `voided`.\n\
                    * adjusted -\n  The credit note has been adjusted against an invoice.\
                    \  \n  **Constraints**\n\n  * Must only be set when `type` is\
                    \ `adjustment`.\n  * Requires `allocations[]` to be provided and\
                    \ `linked_refunds[]` must not be provided.\n"
                  enum:
                  - adjusted
                  - refunded
                  - refund_due
                  - voided
                  example: null
                total:
                  type: integer
                  format: int64
                  default: 0
                  deprecated: false
                  description: "The total amount of the credit note.  \n**Constraints**\n\
                    \n* For refundable credit notes (`type` = `refundable`), this\
                    \ must be less than or equal to the reference invoice's [refundable\
                    \ amount](/docs/api/invoices/invoice-object#refundable-amount).\n\
                    * For adjustment credit notes (`type` = `adjustment`), this must\
                    \ be less than or equal to the reference invoice's [`amount_to_collect`](/docs/api/invoices/invoice-object#invoice_amount_to_collect).\n"
                  minimum: 0
                  example: null
                refunded_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The timestamp when this credit note was fully used (refunded or allocated). This field is automatically set when the credit note `status` becomes `refunded` or `adjusted`.
                  example: null
                voided_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: "The timestamp indicating when this credit note was\
                    \ voided.  \n**Constraints**\n\n* `status` must be `voided`. \
                    \ \n**Default value**\n\n* The credit note `date`.\n"
                  example: null
                sub_total:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    The credit note sub-total (total before round-off, fractional correction, and taxes).
                  minimum: 0
                  example: null
                round_off_amount:
                  type: integer
                  format: int64
                  deprecated: false
                  description: "The rounded-off amount for the credit note. For example,\
                    \ if the credit note amount is $99.99 and it is rounded off to\
                    \ $100.00, then $0.01 is the `round_off_amount`.  \n**Constraints**\n\
                    \n* Not supported for zero-decimal [currencies](/docs/api/currencies).\n"
                  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: |
                    An overridden value for the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number).
                    Only applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)

                    `country`
                    as `XI`
                    (which is **United Kingdom - Northern Ireland**
                    ).

                    When you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)
                    in 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)
                    the Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)

                    `country`
                    as `XI`.
                    That's the code for **United Kingdom - Northern Ireland** .
                    The first two characters of the VAT number in such a case is
                    `XI`
                    by default. However, if the VAT number was registered in UK, the value should be `GB`.
                    Set
                    `vat_number_prefix`
                    to `GB`
                    for such cases.
                  maxLength: 10
                  example: null
                line_items:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for line items. At least one line item is required.
                  properties:
                    reference_line_item_id:
                      type: array
                      description: "The unique identifier of the [line item](/docs/api/invoices/invoice-object#invoice_line_items)\
                        \ from the reference invoice that this credit note line item\
                        \ reverses.  \n**Constraints**\n\n* If **Validate credit note\
                        \ lines against invoice** is enabled, the [`line_item.id`](/docs/api/invoices/invoice-object#invoice_line_items)\
                        \ must exist in the reference invoice. [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 enable this feature.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    id:
                      type: array
                      description: |
                        The unique identifier for this 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: "The unique identifier of the subscription this\
                        \ line item belongs to.  \n**Constraints**\n\n* Must not be\
                        \ provided if `subscription_id` is provided.\n* The subscription's\
                        \ [customer](/docs/api/subscriptions/subscription-object#subscription_customer_id)\
                        \ must match the [customer](/docs/api/invoices/invoice-object#invoice_customer_id)\
                        \ of the reference invoice.\n"
                      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: "The unit amount of the line item.  \n**Required\
                        \ if**\n\n* Pricing model for the line item is `flat_fee`,\
                        \ `per_unit`, or `volume`.  \n**Constraints**\n\n* If **Validate\
                        \ credit note lines against invoice** is enabled, the amount\
                        \ must not exceed the `unit_amount` of the [line item](/docs/api/invoices/invoice-object#invoice_line_items)\
                        \ in the reference invoice. [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 enable this feature.\n"
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: "The quantity of the line item.  \n**Required if**\n\
                        \n* Pricing model for the line item is `per_unit` or `volume`.\
                        \  \n**Constraints**\n\n* If **Validate credit note lines\
                        \ against invoice** is enabled, the quantity must not exceed\
                        \ the quantity of the [line item](/docs/api/invoices/invoice-object#invoice_line_items)\
                        \ in the reference invoice. [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 enable this feature.\n"
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        example: null
                      example: null
                    amount:
                      type: array
                      description: "The total amount of this line item.  \n**Required\
                        \ if**\n\n* Pricing model for the line item is `stairstep`\
                        \ or `tiered`.\n* `line_items[unit_amount]` is not provided.\
                        \  \n**Constraints**\n\n* Must be consistent with `line_items[unit_amount]`\
                        \ and `line_items[quantity]`, when both are provided.\n* If\
                        \ **Validate credit note lines against invoice** is enabled,\
                        \ the amount must not exceed the `amount` of the [line item](/docs/api/invoices/invoice-object#invoice_line_items)\
                        \ in the reference invoice. [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 enable this feature.\n"
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        example: null
                      example: null
                    unit_amount_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the unit amount of the `line_item`.
                        The value is in major units of the currency. Returned when the `line_item`
                        is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      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 line_item. Returned when the `line_item`
                        is quantity-based and [multi-decimal pricing](/docs/api/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 amount for the `line_item`
                        , in major units of the currency. Typically equals to `unit_amount_in_decimal`
                        x `quantity_in_decimal`.
                        Returned when [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      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.

                          * 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
                        enum:
                        - adhoc
                        - plan_item_price
                        - addon_item_price
                        - charge_item_price
                        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.  \n**Required if**\n\n* `line_items[tax1_amount]`\
                        \ is provided.  \n**Constraints**\n\n* Must match one of `taxes[name]`.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax1_amount:
                      type: array
                      description: "First tax amount.  \n**Required if**\n\n* `line_items[tax1_name]`\
                        \ is provided.\n"
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax2_name:
                      type: array
                      description: "Second tax name.  \n**Required if**\n\n* `line_items[tax2_amount]`\
                        \ is provided.  \n**Constraints**\n\n* Must match one of `taxes[name]`.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax2_amount:
                      type: array
                      description: "Second tax amount.  \n**Required if**\n\n* `line_items[tax2_name]`\
                        \ is provided.\n"
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax3_name:
                      type: array
                      description: "Third tax name.  \n**Required if**\n\n* `line_items[tax3_amount]`\
                        \ is provided.  \n**Constraints**\n\n* Must match one of `taxes[name]`.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax3_amount:
                      type: array
                      description: "Third tax amount.  \n**Required if**\n\n* `line_items[tax3_name]`\
                        \ is provided.\n"
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax4_name:
                      type: array
                      description: "Fourth tax name.  \n**Required if**\n\n* `line_items[tax4_amount]`\
                        \ is provided.  \n**Constraints**\n\n* Must match one of `taxes[name]`.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax4_amount:
                      type: array
                      description: "Fourth tax amount.  \n**Required if**\n\n* `line_items[tax4_name]`\
                        \ is provided.\n"
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax5_name:
                      type: array
                      description: "Fifth tax name.  \n**Required if**\n\n* `line_items[tax5_amount]`\
                        \ is provided.  \n**Constraints**\n\n* Must match one of `taxes[name]`.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax5_amount:
                      type: array
                      description: "Fifth tax amount.  \n**Required if**\n\n* `line_items[tax5_name]`\
                        \ is provided.\n"
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax6_name:
                      type: array
                      description: "Sixth tax name.  \n**Required if**\n\n* `line_items[tax6_amount]`\
                        \ is provided.  \n**Constraints**\n\n* Must match one of `taxes[name]`.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax6_amount:
                      type: array
                      description: "Sixth tax amount.  \n**Required if**\n\n* `line_items[tax6_name]`\
                        \ is provided.\n"
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax7_name:
                      type: array
                      description: "Seventh tax name.  \n**Required if**\n\n* `line_items[tax7_amount]`\
                        \ is provided.  \n**Constraints**\n\n* Must match one of `taxes[name]`.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax7_amount:
                      type: array
                      description: "Seventh tax amount.  \n**Required if**\n\n* `line_items[tax7_name]`\
                        \ is provided.\n"
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax8_name:
                      type: array
                      description: "Eighth tax name.  \n**Required if**\n\n* `line_items[tax8_amount]`\
                        \ is provided.  \n**Constraints**\n\n* Must match one of `taxes[name]`.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax8_amount:
                      type: array
                      description: "Eighth tax amount.  \n**Required if**\n\n* `line_items[tax8_name]`\
                        \ is provided.\n"
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax9_name:
                      type: array
                      description: "Ninth tax name.  \n**Required if**\n\n* `line_items[tax9_amount]`\
                        \ is provided.  \n**Constraints**\n\n* Must match one of `taxes[name]`.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax9_amount:
                      type: array
                      description: "Ninth tax amount.  \n**Required if**\n\n* `line_items[tax9_name]`\
                        \ is provided.\n"
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    tax10_name:
                      type: array
                      description: "Tenth tax name.  \n**Required if**\n\n* `line_items[tax10_amount]`\
                        \ is provided.  \n**Constraints**\n\n* Must match one of `taxes[name]`.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    tax10_amount:
                      type: array
                      description: "Tenth tax amount.  \n**Required if**\n\n* `line_items[tax10_name]`\
                        \ is provided.\n"
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    is_partial_tax_applied:
                      type: array
                      description: "Indicates whether tax is applied only to a portion\
                        \ of the line item amount.  \n**Constraints**\n\n* Must not\
                        \ be provided when the line item has no taxes.\n"
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    taxable_amount:
                      type: array
                      description: "The portion of the line item amount, in cents,\
                        \ that is taxable.\nChargebee stores this amount with the\
                        \ imported credit note.  \n**Required if**\n\n* `line_items[is_partial_tax_applied]`\
                        \ is `true`.  \n**Constraints**\n\n* Must not be provided\
                        \ when the line item has no taxes.\n"
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    proration_mode:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Proration mode for the line item.
                        enum:
                        - reset
                        - delta
                        - service_period_revision
                        - adjusted_term
                        example: null
                      example: null
                  required:
                  - description
                  example: null
                line_item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for line item tiers. Used to specify tiered pricing details for line items with `tiered`, `volume`, or `stairstep` pricing models.
                  properties:
                    line_item_id:
                      type: array
                      description: |
                        The unique identifier of the line item this tier belongs to.
                      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 the unit range for this tier. Not applicable for the highest tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    quantity_used:
                      type: array
                      description: |
                        The number of units purchased within this tier range.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_amount:
                      type: array
                      description: |
                        The price of the tier if the charge model is a `stairtstep`
                        pricing , or the price of each unit in the tier if the charge model is `tiered`
                        /`volume`
                        pricing.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the `line_items.pricing_model`
                        is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the `line_items.pricing_model`
                        is `tiered`
                        , `volume`
                        or stairstep and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    quantity_used_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity purchased from this tier. Returned when the `line_item`
                        is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_amount_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for `line_item`.
                        The value is in major units of the currency. Returned when the `line_item`
                        is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      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. Used to specify discounts, coupons, or promotional credits applied to the credit note at the document level or item level.
                  properties:
                    line_item_id:
                      type: array
                      description: "The unique identifier of the line item that this\
                        \ deduction is for. This must match the `line_items[id]` of\
                        \ the line item to which the discount is applied.  \n**Required\
                        \ if**\n\n* `discounts[entity_type]` is `item_level_coupon`\
                        \ or `item_level_discount`.  \n**Constraints**\n\n* The line\
                        \ item must have an `id` specified (i.e., `line_items[id]`\
                        \ must be provided for the line item).\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    entity_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: "The type of deduction and the amount to which\
                          \ it is applied. Determines whether the discount is applied\
                          \ at the document level or item level, and whether it's\
                          \ a coupon, discount, or promotional credit.\n\n* document_level_coupon\
                          \ -\n  The deduction is due to a [coupon](/docs/api/coupons)\
                          \ applied at the document level.  \n  **Constraints**\n\n\
                          \  * Requires `discounts[entity_id]` to be provided to identify\
                          \ the coupon.\n* item_level_coupon -\n  The deduction is\
                          \ due to a [coupon](/docs/api/coupons) applied at the line\
                          \ item level.  \n  **Constraints**\n\n  * `discounts[line_item_id]`\
                          \ is required and must match the `line_items[id]` of the\
                          \ line item.\n  * Requires `discounts[entity_id]` to be\
                          \ provided to identify the coupon.\n* item_level_discount\
                          \ -\n  The deduction is due to a [discount](/docs/api/discounts)\
                          \ applied at the line item level.  \n  **Constraints**\n\
                          \n  * `discounts[line_item_id]` is required and must match\
                          \ the `line_items[id]` of the line item.\n  * `discounts[entity_id]`\
                          \ must not be provided.\n* promotional_credits -\n  The\
                          \ deduction is due to a [promotional credit](/docs/api/promotional_credits)\
                          \ applied.  \n  **Constraints**\n\n  * Only one promotional\
                          \ credit discount entry is allowed per credit note.\n  *\
                          \ `discounts[entity_id]` must not be provided.\n* document_level_discount\
                          \ -\n  The deduction is due to a [discount](/docs/api/discounts)\
                          \ applied at the document level.  \n  **Constraints**\n\n\
                          \  * `discounts[entity_id]` must not be provided.\n"
                        enum:
                        - item_level_coupon
                        - document_level_coupon
                        - promotional_credits
                        - item_level_discount
                        - document_level_discount
                        example: null
                      example: null
                    entity_id:
                      type: array
                      description: "The unique identifier of the [coupon](/docs/api/coupons).\
                        \  \n**Required if**\n\n* `discounts[entity_type]` is `item_level_coupon`\
                        \ or `document_level_coupon`.  \n**Constraints**\n\n* Must\
                        \ not be provided when `discounts[entity_type]` is `document_level_discount`\
                        \ or `item_level_discount`.\n* For `item_level_coupon`, the\
                        \ coupon must be applicable to the plan or addon associated\
                        \ with the line item.\n* For `document_level_coupon`, the\
                        \ coupon must have `apply_on` set to `invoice_amount`.\n"
                      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 document-level taxes. Used to specify\
                    \ tax information at the credit note level.  \n**Prerequisite**\n\
                    \n* `taxes[]` must not be provided if the reference invoice has\
                    \ **all** line items exempted from tax for any one of the following\
                    \ reasons: `customer_exempt`, `reverse_charge`, or `export` (i.e.\
                    \ if all [`line_items[].tax_exempt_reason`](/docs/api/invoices/invoice-object#invoice_line_items)\
                    \ on the reference invoice are set to `customer_exempt`, `reverse_charge`,\
                    \ or `export`).\n"
                  properties:
                    name:
                      type: array
                      description: "The name of the tax applied.  \n**Constraints**\n\
                        \n* Must match at least one `line_items[tax*_name]`.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    rate:
                      type: array
                      description: "The rate of tax.  \n**Note**\n\n* This parameter\
                        \ is only used to disambiguate between multiple taxes with\
                        \ the same `name` and other tax metadata. It is not used to\
                        \ calculate or validate the tax amount.\n"
                      items:
                        type: number
                        format: double
                        default: 0
                        deprecated: false
                        maximum: 100
                        minimum: 0
                        example: null
                      example: null
                    amount:
                      type: array
                      description: "The total tax amount for this credit note.  \n\
                        **Constraints**\n\n* Must match the sum of the line-level\
                        \ tax amounts (`line_items[tax*_amount][]`) for the given\
                        \ combination of `name`, `rate`, `juris_type`, `juris_name`,\
                        \ and `juris_code`.\n"
                      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 credit allocations. Used to specify\
                    \ how the credit note amount is allocated to invoices.  \n**Required\
                    \ if**\n\n* `status` is `adjusted`.  \n**Constraints**\n\n* For\
                    \ adjustment credit notes (`type` = `adjustment`), only one allocation\
                    \ is allowed.\n* Must not be provided if `status` is `voided`.\n"
                  properties:
                    invoice_id:
                      type: array
                      description: |
                        The unique identifier of the invoice to which this credit note amount is allocated. The invoice must already exist in Chargebee.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    allocated_amount:
                      type: array
                      description: "The amount allocated from this credit note to\
                        \ the specified invoice.  \n**Constraints**\n\n* The sum of\
                        \ `allocated_amount[]` plus the sum of `linked_refunds[amount][]`\
                        \ must not exceed the `total`.\n"
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    allocated_at:
                      type: array
                      description: "The timestamp when the allocation occurred.  \n\
                        **Constraints**\n\n* Must be equal to or after the credit\
                        \ note `date`.  \n**Default value**\n\n* The credit note `date`.\n"
                      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. Used to record refund\
                    \ transactions associated with this credit note.  \n**Required\
                    \ if**\n\n* `status` is `refunded` and no `allocations[]` are\
                    \ provided.  \n**Constraints**\n\n* Must not be provided if `status`\
                    \ is `adjusted` or `voided`.\n"
                  properties:
                    id:
                      type: array
                      description: ""
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    amount:
                      type: array
                      description: "The amount of this refund transaction.  \n**Constraints**\n\
                        \n* The sum of `linked_refunds[amount][]` plus the sum of\
                        \ `allocations[allocated_amount][]` must not exceed the `total`\
                        \ of the credit note.\n"
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    payment_method:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The payment method used for the refund.

                          * other - Payment Methods other than the above types
                          * cash - Cash
                          * custom - Custom
                          * bank_transfer - Bank Transfer
                          * check - Check
                        enum:
                        - cash
                        - check
                        - bank_transfer
                        - other
                        - custom
                        - tamara
                        - qpay
                        - blik
                        - fpx
                        - wero
                        - p24
                        example: null
                      example: null
                    date:
                      type: array
                      description: "The date when the refund occurred.  \n**Constraints**\n\
                        \n* Must be a date in the past.\n"
                      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: |
                      Resource object representing credit_note
                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:
      tags:
      - credit_notes
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing credit_note
                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:
      tags:
      - credit_notes
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing download
                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:
      tags:
      - credit_notes
      summary: Send an einvoice for credit notes
      description: |+
        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:

        * If e-invoicing is not enabled at the site and customer level.

        * If there is an e-invoice generated already for the invoice.

        * If the **Use automatic e-invoicing** option is selected.

        * If there are no generated e-invoices with the `failed` or `skipped` status.

        * If the invoice status is `voided` or `pending`.

      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing credit_note
                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:
      tags:
      - credit_notes
      summary: Void a credit note
      description: "Void or invalidate the specified credit note.\n\nUse this operation\
        \ for incorrectly generated credit notes, such as those with wrong details\
        \ or created by mistake. This is a preferred method over [deleting the credit\
        \ note](/docs/api/credit_notes/delete-a-credit-note), as it preserves the\
        \ audit trail, allowing for future reference and compliance without removing\
        \ the original record.  \n\n### Prerequisites \\& Constraints\n\n* The credit\
        \ note `status` must not be `refunded` or `voided`.\n* For credit notes of\
        \ `type` `refundable`, you must remove any allocations or linked refunds before\
        \ voiding it. Note that only offline refunds can be removed; online refunds\
        \ cannot.\n\nSee **Implementation Notes** for more details.  \n\n### Impacts\n\
        \n**Invoices**  \nIf the credit note `type` is `adjustment`, the associated\
        \ invoice `status` changes to `not_paid`, and the `amount_due` on the invoice\
        \ increases by the amount that was allocated via the credit note.  \n\n###\
        \ Implementation Notes\n\nBefore calling this API, ensure the following:\n\
        \n* The credit note [`status`](/docs/api/credit_notes/credit_note-object#status)\
        \ must not be `refunded` or `voided`.\n* For credit notes of [`type`](/docs/api/credit_notes/credit_note-object#type)\
        \ `refundable`:\n  * Remove any [allocations](/docs/api/credit_notes/credit_note-object#allocations)\
        \ of the credit note to invoices by calling the [Remove credit note from an\
        \ invoice API](/docs/api/invoices/remove-credit-note-from-an-invoice).\n*\
        \ Remove any [linked offline refunds](/docs/api/credit_notes/credit_note-object#linked_refunds)\
        \ by calling the [Delete an offline transaction API](/docs/api/transactions/delete-an-offline-transaction).\
        \  \n\n#### Related APIs\n\n[Delete a credit note](/docs/api/credit_notes?prod_cat_ver=2#delete_a_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing credit_note
                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:
      tags:
      - credit_notes
      summary: Refund a credit note
      description: "Refunds a specified amount from a refundable credit note back\
        \ to the customer's payment source.\n\nThis operation supports only refunds\
        \ against online payments. The refund amount is returned to the customer through\
        \ the [`payment_source`](/docs/api/payment_sources) associated with the transaction.\
        \ If multiple transactions are associated with the credit note, call this\
        \ API once for each transaction.\n\nTo record offline refunds, including those\
        \ for [`linked_taxes_withheld`](/docs/api/invoices/invoice-object#linked_taxes_withheld),\
        \ use the [Record refund for a credit note](/docs/api/credit_notes/refund-a-credit-note)\
        \ API.  \n\n### Prerequisites \\& Constraints\n\n* The credit note [`type`](/docs/api/credit_notes/credit_note-object#type)\
        \ is `refundable`.\n* The credit note [`status`](/docs/api/credit_notes/credit_note-object#status)\
        \ is `refund_due`.\n* The credit note has an `amount_available` greater than\
        \ 0.\n* Part or all of the credit note's `amount_available` is from online\
        \ payments.\n* The credit note is not [standalone](https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/credit-notes#creating-standalone-credits);\
        \ it has an associated invoice.\n* You can process partial refunds only if\
        \ the associated payment gateway supports partial refund operations.  \n\n\
        ### Impacts\n\n**Credit note**  \n* The credit note's `amount_available` is\
        \ reduced by the refunded amount.\n* The credit note's `status` is updated\
        \ to `refunded` if the refunded amount is equal to the credit note's `amount_available`.\n\
        * The credit note's [`linked_refunds`](/docs/api/credit_notes/credit_note-object#linked_refunds)\
        \ is updated with the details of the refund transaction.  \n**Transaction**\
        \  \nChargebee creates a transaction of [`type`](/docs/api/transactions/transaction-object#type)\
        \ `refund` and links it to the credit note under `credit_note.linked_refunds`.\
        \  \n\n### Implementation Notes\n\nBefore you call this API, make sure the\
        \ following conditions are met:\n\n* The credit note [`type`](/docs/api/credit_notes/credit_note-object#type)\
        \ is `refundable`.\n* The credit note [`status`](/docs/api/credit_notes/credit_note-object#status)\
        \ is `refund_due`.\n* The credit note has an `amount_available` greater than\
        \ 0.\n* The credit note has the `reference_invoice_id` set.\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: "The amount to be refunded.  \n**Constraints**\n\n\
                    * If multiple [transactions](/docs/api/invoices/invoice-object#linked_payments)\
                    \ are associated with the credit note, the refund can be processed\
                    \ only for one transaction at a time.\n* Offline refunds, including\
                    \ those for [`linked_taxes_withheld`](/docs/api/invoices/invoice-object#linked_taxes_withheld),\
                    \ cannot be refunded via this operation. Use the [Record refund\
                    \ for a credit note](/docs/api/credit_notes/refund-a-credit-note)\
                    \ API instead.  \n**Default behavior**\n\n* If not specified,\
                    \ the `amount_available` for this credit note is implied.\n"
                  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: |
                      Resource object representing credit_note
                  transaction:
                    $ref: "#/components/schemas/Transaction"
                    description: |
                      Resource object representing transaction
                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:
      tags:
      - credit_notes
      summary: List credit notes
      description: |
        Lists all the Credit Notes.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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_not\] = "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\[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: 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_not\] = "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\[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_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\[lte\] = "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\[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. 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\[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: 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.\n* `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.\n* `play_store` -\n  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.  \n  In-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.\n* `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.\n* `play_store` -\n  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.  \n  In-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.\n* `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.\n* `play_store` -\n  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.  \n  In-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.\n* `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.\n* `play_store` -\n  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.  \n  In-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: |
                The status of processing the e-invoice. To obtain detailed information about the current `status`
                , see `message`
                .
              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 `entity_identifier` 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 `entity_identifier` 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 `entity_identifier` 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 `entity_identifier` 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:
      tags:
      - credit_notes
      summary: Create credit note
      description: "Creates a credit note for the specified invoice.  \n\n### Impacts\n\
        \n**Invoice**  \nSee [Impact on reference invoice](/docs/api/credit_notes/credit-note-object#ref-invoice-impact).\
        \  \n**Credit note**  \n* A new credit note of the specified `type` is created.\n\
        * If the credit note `type` is `adjustment`:\n  * `total` and `amount_allocated`\
        \ are set to the adjusted amount.\n  * `status` is set to `adjusted`.\n* If\
        \ the credit note `type` is `refundable` or `store`:\n  * `total` and `amount_available`\
        \ are set to the refundable amount.\n  * `status` is set to `refund_due`.\n\
        * The `taxes[].amount` and `line_item_taxes[].tax_amount` are set to the corresponding\
        \ values on the invoice, prorated by the ratio of `credit_note.total` to `invoice.total`.\n"
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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.  \n**Required when**\n\n* `type` is `adjustment`\
                    \ or `store`.  \n**Note**\nWhen not provided and `type` is `refundable`,\
                    \ then `customer_id` must be provided because this creates a [standalone\
                    \ credit note](https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/credit-notes#standalone-credits).\n"
                  maxLength: 50
                  example: null
                customer_id:
                  type: string
                  deprecated: false
                  description: "The identifier of the customer for whom this credit\
                    \ note is issued.  \n**Required when**\n\n* `type` is `refundable`\
                    \ and `reference_invoice_id` is not provided. This creates a [standalone\
                    \ credit note](https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/credit-notes#standalone-credits).\n"
                  maxLength: 50
                  example: null
                total:
                  type: integer
                  format: int64
                  default: 0
                  deprecated: false
                  description: "The total credit note amount.  \n**Constraints**\n\
                    \n* Pass either the `total` or `line_items` parameter.\n* If `type`\
                    \ is `adjustment`, `total` must not exceed the amount due on the\
                    \ invoice minus the total amount of any transactions in progress\
                    \ for the invoice. Calculate this as `invoice.amount_due` minus\
                    \ the sum of `invoice.linked_payments[i].amount` where `invoice.linked_payments[i].txn_status`\
                    \ is `in_progress`.\n* If `type` is `refundable` or `store`:\n\
                    \  * If `reference_invoice_id` is provided, `total` must not exceed\
                    \ the refundable amount on the invoice. Calculate the refundable\
                    \ amount as the sum of:\n    * Sum of `linked_payments[i].amount`\
                    \ where `linked_payments[i].txn_status` is `success`\n    * Sum\
                    \ of `applied_credits[i].applied_amount` where `applied_credits[i].status`\
                    \ is not `voided`\n    * Sum of `linked_taxes_withheld[].amount`\n\
                    \    * Minus the sum of `issued_credit_notes[i].cn_total` where\
                    \ `issued_credit_notes[i].status` is not `voided`\n  * If `reference_invoice_id`\
                    \ is not provided, there is no limit on the `total` because this\
                    \ creates a [standalone credit note](https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/credit-notes#standalone-credits).\n"
                  minimum: 0
                  example: null
                type:
                  type: string
                  deprecated: false
                  description: "The [type](/docs/api/credit_notes/credit-note-object)\
                    \ of credit note to create.  \n**Prerequisites**\n\n* If `type`\
                    \ is `adjustment`, the `invoice.status` must be `payment_due`,\
                    \ `posted` or `not_paid`.\n* If `type` is `refundable` or `store`,\
                    \ the `invoice.status` must be `paid`, `payment_due`, `posted`,\
                    \ or `not_paid`.\n\n* refundable -\n  Creates a refundable credit\
                    \ note.  \n  **Prerequisites**\n\n  * The `invoice.status` must\
                    \ be `paid`, `payment_due`, `posted`, or `not_paid`.\n* store\
                    \ -\n  Creates a store credit note.  \n  **Prerequisites**\n\n\
                    \  * The `invoice.status` must be `paid`, `payment_due`, `posted`,\
                    \ or `not_paid`.\n* adjustment -\n  Creates an adjustment credit\
                    \ note.  \n  **Prerequisites**\n\n  * The `invoice.status` must\
                    \ be `payment_due`, `posted` or `not_paid`.\n"
                  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\].

                    * waiver - Waiver
                    * order_cancellation - Order Cancellation
                    * order_change - Order Change
                    * product_unsatisfactory - Product Unsatisfactory
                    * service_unsatisfactory - Service Unsatisfactory
                    * other - Can be set when none of the above reason codes are applicable
                  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.  \n**Constraints**\n\
                    \n* Must be one of the case-sensitive [reason codes](https://www.chargebee.com/docs/billing/2.0/site-configuration/reason-codes#managing-reason-codes-for-credit-notes)\
                    \ set in Chargebee Billing.  \n**Required when**\n\n* Reason codes\
                    \ are configured as mandatory on the site.\n"
                  maxLength: 100
                  example: null
                date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: "The date on which the credit note is issued.  \n**Constraints**\n\
                    \n* Must be on or after the `invoice.date` and cannot be a future\
                    \ date.\n"
                  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
                  description: |
                    The currency code (ISO 4217 format) for the credit note. It is required for a standalone credit note if Multicurrency is enabled.
                  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: |
                        The decimal representation of the unit amount of the `line_item`.
                        The value is in major units of the currency. Applicable for the line_item when the `pricing_model`
                        is `flat_fee`
                        , `per_unit`
                        or `volume`.
                        Can be provided only when [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      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: |
                        The decimal representation of the quantity of the `line_item`.
                        Applicable for the `line_item`
                        when the `pricing_model`
                        is `per_unit`
                        and `volume`.
                        Can be provided only when [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      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: |
                          * addon_item_price - Indicates that this line item is based on an addon item price.
                          * charge_item_price - Indicates that this line item is based on a charge item price.
                          * adhoc - Indicates that this line item is not modelled; that is, it was created ad hoc. The `entity_id` attribute is `null` in this case.
                          * plan_item_price - Indicates that this line item is based on a plan item price.
                        enum:
                        - adhoc
                        - plan_item_price
                        - addon_item_price
                        - charge_item_price
                        example: null
                      example: null
                    entity_id:
                      type: array
                      description: ""
                      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: |
                      Resource object representing credit_note
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: |
                      Resource object representing invoice
                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}/update:
    post:
      tags:
      - credit_notes
      summary: Update Credit Note Details
      description: "Updates the [custom fields](/docs/api/advanced-features#custom-fields)\
        \ and comment of a [credit note](/docs/api/credit_notes).\n\nUse this operation\
        \ to add or change custom field values, or to attach an internal comment,\
        \ without modifying other credit note attributes. Pass at least one credit\
        \ note custom field or `comment`; otherwise the credit note is returned unchanged.\
        \  \n\n### Impacts\n\n**Credit note**  \n* Updates any credit note [custom\
        \ fields](/docs/api/advanced-features#custom-fields) included in the request.\
        \ Existing custom field values that you omit from the request are left unchanged.\n\
        * Adds an internal [comment](/docs/api/comments) when you pass `comment`.\n"
      operationId: update_credit_note_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
              additionalProperties: true
              properties:
                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
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  credit_note:
                    $ref: "#/components/schemas/CreditNote"
                    description: |
                      Resource object representing credit_note
                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:
      tags:
      - credit_notes
      summary: Download e-invoice for credit note
      description: "Download the e-invoice for the credit note in both XML and PDF\
        \ formats. The response consists of a `download` object for each format. The\
        \ XML format follows the [structure as per Peppol BIS Billing v3.0](https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/tree/).\
        \  \n**Note**\n\n* You can only download e-invoices when their `status` is\
        \ `success` or `registered`.\n* 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 [cbc:EmbeddedDocumentBinaryObject](https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AdditionalDocumentReference/cac-Attachment/cbc-EmbeddedDocumentBinaryObject/),\
        \ which is the Base64-encoded version of the PDF.\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
                  downloads:
                    type: array
                    description: |
                      Resource object representing download
                    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:
      tags:
      - credit_notes
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing credit_note
                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:
      tags:
      - credit_notes
      summary: Remove tax withheld refunds from a credit note
      description: |
        Removes a [linked_tax_withheld_refunds](/docs/api/credit_notes/credit_note-object#linked_tax_withheld_refunds)
        record from the `credit_note`
        .
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                        An auto-generated unique identifier for the tax withheld. The value starts with the prefix `tax_wh_`.
                        For example, `tax_wh_16BdDXSlbu4uV1Ee6`
                        .
                      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: |
                      Resource object representing credit_note
                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:
      tags:
      - credit_notes
      summary: Retrieve a credit note
      description: |
        Retrieves the Credit Note identified by the specified Credit Note number.
      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: "Specify the starting point for retrieving line items. Use the\
          \ value from the `line_items_next_offset` attribute of the previous retrieve\
          \ API 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: 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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing credit_note
                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}/send_email:
    post:
      tags:
      - credit_notes
      summary: Send Credit Note Email
      description: "Sends the credit note email to the customer using the site's published\
        \ **Send Credit Note Email** Engage notification template.\n\nUse this operation\
        \ to resend or manually trigger the credit note email for a customer outside\
        \ the normal notification schedule.  \n**Async-only**\nThis operation is [asynchronous\
        \ only](/docs/api/async_response). You must send `Prefer: respond-async`,\
        \ a unique `chargebee-request-id`, and a `chargebee-async-callback-url`. The\
        \ HTTP response is `202 Accepted` with an empty body. When processing completes,\
        \ Chargebee delivers the outcome to your [async callback URL](/docs/api/async_response)\
        \ --- a successful `result` contains [`email_logs`](/docs/api/email_logs).\
        \  \n\n### Prerequisites \\& Constraints\n\n* Email Engage V2 must be enabled\
        \ for the site.\n* The **Send Credit Note Email** notification template must\
        \ be published and enabled.\n* The from address configured for the notification\
        \ template must be verified.\n* The customer associated with the credit note\
        \ must have a valid email address.\n* The credit note `status` must not be\
        \ `voided`.\n* The credit note `reason_code` must not be `write_off`.\n"
      operationId: send_credit_note_email
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: Prefer
        in: header
        description: Must be set to `respond-async`. Instructs Chargebee to process
          the request asynchronously and return `202 Accepted` immediately.
        required: true
        deprecated: false
        $ref: "#/components/parameters/Prefer"
        style: simple
        explode: false
        schema:
          type: string
          description: Must be set to `respond-async`. Instructs Chargebee to process
            the request asynchronously and return `202 Accepted` immediately.
          example: respond-async
      - name: chargebee-request-id
        in: header
        description: "A client-generated unique identifier (UUID recommended) for\
          \ this request. Echoed back as `request.id` in the async callback payload,\
          \ allowing you to correlate each callback to its originating request."
        required: true
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "A client-generated unique identifier (UUID recommended) for\
            \ this request. Echoed back as `request.id` in the async callback payload,\
            \ allowing you to correlate each callback to its originating request."
          example: 7c9e2f4a-8b1d-4e6f-9a0c-3d5e7f9b1c2d
          maxLength: 100
      - name: chargebee-async-callback-url
        in: header
        description: "The callback URL where Chargebee will `POST` the async result.\
          \ Must be an `https://` URL and may embed basic-auth credentials, e.g. `https://username:password@example.com`."
        required: true
        deprecated: false
        $ref: "#/components/parameters/chargebee-async-callback-url"
        style: simple
        explode: false
        schema:
          type: string
          format: uri
          description: "The callback URL where Chargebee will `POST` the async result.\
            \ Must be an `https://` URL and may embed basic-auth credentials, e.g.\
            \ `https://username:password@example.com`."
          example: https://username:password@example.com
      - 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:
                  email_logs:
                    type: array
                    description: |
                      List of [email log](/docs/api/email_logs) objects for the send request. Each entry describes one email that was sent or attempted.
                    items:
                      $ref: "#/components/schemas/EmailLog"
                      description: Resource object representing email_log
                    example: null
                required:
                - email_logs
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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:
      tags:
      - unbilled_charges
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing unbilled_charge
                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:
      tags:
      - unbilled_charges
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing estimate
                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:
      tags:
      - unbilled_charges
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing invoice
                    items:
                      $ref: "#/components/schemas/Invoice"
                      description: |
                        Resource object representing invoice
                    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:
      tags:
      - unbilled_charges
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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: []
    post:
      tags:
      - unbilled_charges
      summary: Create unbilled charges for item subscription
      description: |
        This endpoint creates unbilled charges for a subscription.
      operationId: create_unbilled_charges_for_item_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
                item_prices:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_prices
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        A unique ID for your system to identify the item price.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Item price quantity
                      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 item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        The price or per-unit-price of the item price. By default, it is the [value set](/docs/api/item_prices/item_price-object#price)
                        for the `item_price`.
                        This is only applicable when the `pricing_model`
                        of the `item_price`
                        is `flat_fee`
                        or `per_unit`.
                        The value depends on the [type of currency](/docs/api/currencies)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      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/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 item 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 item ends.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
                item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_tiers
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The id of the item price to which this tier belongs.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: |
                        The lowest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The highest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |
                        The per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        The total cost for the item price when the `pricing_model`
                        is `stairstep`.
                        The value is in the minor unit of the currency.
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    pricing_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Pricing type for the tier.

                          * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                          * flat_fee -
                            Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                            pricing model, `pricing_type`
                            will be set to `flat_fee`
                            by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                          * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                        enum:
                        - per_unit
                        - flat_fee
                        - package
                        example: null
                      example: null
                    package_size:
                      type: array
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        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/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:
              charges:
                style: deepObject
                explode: true
              item_prices:
                style: deepObject
                explode: true
              item_tiers:
                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: |
                      Resource object representing unbilled_charge
                    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:
      tags:
      - orders
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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\] = "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\[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: 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\[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: 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\[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: 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\[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: 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:
      tags:
      - orders
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing order
                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:
      tags:
      - orders
      summary: Import an order
      description: |
        Import an order for an invoice with one or more line items. The import order bulk operation is to be applied on an imported invoice.
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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.

                    * 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
                    * on_hold - The order is paused from being processed.
                    * 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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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: |
                      Resource object representing order
                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:
      tags:
      - orders
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing order
                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:
      tags:
      - orders
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing order
                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:
      tags:
      - orders
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing order
                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:
      tags:
      - orders
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing order
                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:
      tags:
      - orders
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing order
                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:
      tags:
      - orders
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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: |
                      Resource object representing order
                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:
      tags:
      - orders
      summary: Delete an imported order
      description: |
        Deletes only [Imported Order](/docs/api/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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing order
                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:
      tags:
      - orders
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing order
                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/create_for_items:
    post:
      tags:
      - gifts
      summary: Create a gift subscription for items
      description: |
        Create a gift subscription with items like plans, addons, or charges and gift it to an existing customer.
      operationId: create_a_gift_subscription_for_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    When `true`
                    , the claim happens automatically. When not passed, the default value in the site settings is used.
                  example: null
                no_expiry:
                  type: boolean
                  deprecated: false
                  description: |
                    When `true`
                    , indicates that the gift does not expire. Do not pass or pass as `false`
                    when `auto_claim`
                    is set.
                    .
                  example: null
                claim_expiry_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The date until which the gift can be claimed. Must be set to a value after `scheduled_at`.
                    If the gift is not claimed within `claim_expiry_date`
                    , it will expire and the subscription will move to `cancelled`
                    state. When not passed, the value specified in the site settings will be used.
                    Pass as `NULL`
                    or do not pass when `auto_claim`
                    or `no_expiry`
                    are set.
                  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
                meta_data:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: "A [collection of key-value pairs](/docs/api/advanced-features)\
                    \ that provides extra information about the subscription.  \n\
                    **Constraints**\n\n* Character limit: 65,535.\n"
                  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
                        * dotpay - dotpay
                        * faster_payments - Faster Payments
                        * upi - upi
                        * kbc_payment_button - KBC Payment Button
                        * klarna - Payments made via Klarna.
                        * payme - Payments made via PayMe
                        * thai_qr - Payments made via Thai QR.
                        * 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.
                        * tamara - Payments made via Tamara.
                        * ideal - ideal
                        * picpay - Payments made via PicPay.
                        * pay_to - PayTo
                        * ovo - Payments made via OVO.
                        * boleto - boleto
                        * pay_co - Payments made via PayCo
                        * wechat_pay - Payments made via WeChat Pay.
                        * cash_app_pay - Payments made via Cash App Pay.
                        * rakuten_pay - Payments made via Rakuten Pay.
                        * alipay_hk - Payments made via Alipay HK.
                        * after_pay - Payments made via Afterpay
                        * netbanking_emandates - netbanking_emandates
                        * nequi - Payments made via Nequi.
                        * grab_pay - Payments made via GrabPay
                        * paypay - PayPay
                        * payconiq_by_bancontact - Payments made via Payconiq by Bancontact.
                        * mercado_pago - Payments made via Mercado Pago.
                        * p24 - Payments made via Przelewy24 (P24).
                        * electronic_payment_standard - Electronic Payment Standard
                        * direct_debit - direct_debit
                        * sepa_instant_transfer - Sepa Instant Transfer
                        * bancontact - bancontact
                        * wero - Payments made via Wero.
                        * pay_by_bank - Pay By Bank
                        * touch_n_go - Payments made via Touch 'n Go.
                        * apple_pay - apple_pay
                        * qpay - Payments made via Qpay.
                        * online_banking_poland - Online Banking Poland
                        * gcash - Payments made via GCash.
                        * nupay - Payments made via NuPay.
                        * giropay - giropay
                        * momo - Payments made via MoMo.
                        * sofort - sofort
                        * amazon_payments - Amazon Payments
                        * affirm_pay - Payments made via Affirm Pay.
                        * kakao_pay - Payments made via Kakao Pay.
                        * fpx - Payments made via FPX.
                        * blik - Payments made via BLIK.
                        * dana - Payments made via Dana.
                        * south_korean_cards - Payments made via South Korean Cards
                        * 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
                      - alipay_hk
                      - paypay
                      - gcash
                      - south_korean_cards
                      - paynow
                      - bizum
                      - promptpay
                      - dana
                      - touch_n_go
                      - tamara
                      - qpay
                      - ovo
                      - momo
                      - mercado_pago
                      - nequi
                      - nupay
                      - picpay
                      - thai_qr
                      - blik
                      - fpx
                      - wero
                      - p24
                      - affirm_pay
                      - rakuten_pay
                      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: |
                        * `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal).

                          * `payer`: User related information.
                            * `country_of_residence`: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a [two-character ISO code](https://docs.checkout.com/resources/codes/country-codes).
                            * `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
                        * `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
                        * `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user's `device_session_id` can be added to perform [additional validation](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                            * `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
                        * `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
                        * `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                        * `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.

                          * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
                        * `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.

                          * `payer`: User related information.
                            * `document`: Document is the user's identification number based on their country.
                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada and India If `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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_items:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription_items
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The unique identifier of the item price.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        The quantity of the item purchased
                      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 item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: "The price/per unit price of the item. The value\
                        \ is interpreted as per the type of [currency](/docs/api/currencies).\
                        \  \n**Prerequisites**\n\n* The `pricing_model` of the item\
                        \ price is `flat_fee` or `per_unit`.\n* [Price overriding](https://www.chargebee.com/docs/price-override.html)\
                        \ is enabled for the site.  \n**Default value**\n\n* [`item_price.price`](/docs/api/item_prices/item_price-object#price).\n"
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: "The price/per unit price of the item in major\
                        \ units of the [currency](/docs/api/currencies). When not\
                        \ provided, the [value set for the item price](/docs/api/item_prices/item_price-object#price)\
                        \ is used.  \n**Prerequisites**\n\n* The `pricing_model` of\
                        \ the item price is `flat_fee` or `per_unit`.\n* [Multi-decimal](https://www.chargebee.com/docs/billing/2.0/site-configuration/multi-decimal-support#configuring-multi-decimal-support)\
                        \ pricing is enabled.\n* [Price overriding](https://www.chargebee.com/docs/2.0/price-override.html)\
                        \ is enabled for the site.  \n**Default value**\n\n* [`item_price.price_in_decimal`](/docs/api/item_prices/item_price-object#price_in_decimal).\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                  example: null
                item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_tiers
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The id of the item price for which the tier price is being overridden.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: "The lowest value in the quantity tier.  \n**Constraints**\n\
                        \n* Must be zero for the lowest tier.\n* For all other tiers,\
                        \ it must be equal to the `ending_unit` of the next lower\
                        \ tier.\n"
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: "The highest value in the quantity tier.  \n**Constraints**\n\
                        \n* Not applicable for the highest tier.\n* Must be equal\
                        \ to the `starting_unit` of the next higher tier.\n"
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |
                        The overridden price of the tier. The value depends on the [type of currency](/docs/api/currencies).
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: "The decimal representation of the lowest value\
                        \ of quantity in this tier.  \n**Constraints**\n\n* Must be\
                        \ zero for the lowest tier.\n* For all other tiers, it must\
                        \ be equal to the `ending_unit_in_decimal` of the next lower\
                        \ tier.  \n**Prerequisite**\n\n* [Multi-decimal](https://www.chargebee.com/docs/billing/2.0/site-configuration/multi-decimal-support#configuring-multi-decimal-support)\
                        \ pricing is enabled.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: "The decimal representation of the highest value\
                        \ of quantity in this tier.  \n**Constraints**\n\n* Not applicable\
                        \ for the highest tier.\n* Must be equal to the `starting_unit_in_decimal`\
                        \ of the next higher tier.  \n**Prerequisite**\n\n* [Multi-decimal](https://www.chargebee.com/docs/billing/2.0/site-configuration/multi-decimal-support#configuring-multi-decimal-support)\
                        \ pricing is enabled.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: "* The decimal representation of the per-unit price\
                        \ for the tier when the [item_price.pricing_model](/docs/api/item_prices/item_price-object#pricing_model)\
                        \ is `tiered` or `volume`.\n* The decimal representation of\
                        \ the total price for the item when the [item_price.pricing_model](/docs/api/item_prices/item_price-object#pricing_model)\
                        \ is `stairstep`.\n\n**Constraints**\n\n* The value must be\
                        \ in major units of the [currency](/docs/api/currencies).\
                        \  \n**Prerequisite**\n\n* [Multi-decimal](https://www.chargebee.com/docs/billing/2.0/site-configuration/multi-decimal-support#configuring-multi-decimal-support)\
                        \ pricing is enabled.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              gift_receiver:
                style: deepObject
                explode: true
              gifter:
                style: deepObject
                explode: true
              item_tiers:
                style: deepObject
                explode: true
              payment_intent:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              subscription_items:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  gift:
                    $ref: "#/components/schemas/Gift"
                    description: |
                      Resource object representing gift
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: |
                      Resource object representing subscription
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: |
                      Resource object representing invoice
                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}/cancel:
    post:
      tags:
      - gifts
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing gift
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: |
                      Resource object representing subscription
                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:
      tags:
      - gifts
      summary: Update a gift
      description: "Updates the attributes of a gift.  \n\n### Prerequisites \\& Constraints\n\
        \n* The gift must be in the `scheduled` [status](/docs/api/gifts/gift-object#status).\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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 the current time. If [`no_expiry`](/docs/api/gifts/gift-object#no_expiry) is false, 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. 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
                gift_receiver:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for gift_receiver.
                  properties:
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        The email address of the gift recipient. Must be a valid email address.
                      maxLength: 70
                      example: null
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        First name of the recipient.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        Last name of the recipient.
                      maxLength: 150
                      example: null
                  example: null
              example: null
            encoding:
              gift_receiver:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                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
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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:
      tags:
      - gifts
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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: []
  /gifts/{gift-id}:
    get:
      tags:
      - gifts
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing gift
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: |
                      Resource object representing subscription
                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:
      tags:
      - gifts
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing gift
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: |
                      Resource object representing subscription
                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:
      tags:
      - transactions
      summary: List transactions
      description: "Lists all the transactions.  \n**Note:**\n\nFor better query performance,\
        \ we recommend using a `date` filter (for example, `date[after]` or `date[between]`)\
        \ when listing transactions. If you are already filtering by `updated_at`,\
        \ you do not need to also filter by `date`.\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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, alipay_hk, gcash, ovo, momo, mercado_pago, nequi, nupay, picpay, thai_qr, blik, fpx, wero, p24, affirm_pay, rakuten_pay, dana, touch_n_go, tamara, qpay, 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_not\] = "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 [type](transactions#transaction_type) = `refund`. This value is set by Chargebee when an automated [chargeback](https://www.chargebee.com/docs/chargeback.html#chargeback-process) occurs. You can also set this explicitly when [recording a refund](transactions#record_an_offline_refund).
                * `bank_transfer` - Bank Transfer
                * `amazon_payments` - Amazon Payments
                * `paypal_express_checkout` - Paypal Express Checkout
                * `direct_debit` - Direct Debit
                * `alipay` - Alipay
                * `unionpay` - Unionpay
                * `apple_pay` - Apple Pay
                * `wechat_pay` - WeChat Pay
                * `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
                * `pay_to` - PayTo
                * `faster_payments` - Faster Payments
                * `sepa_instant_transfer` - Sepa Instant Transfer
                * `automated_bank_transfer` - Automated Bank Transfer
                * `klarna_pay_now` - Klarna Pay Now
                * `online_banking_poland` - Online Banking Poland
                * `payconiq_by_bancontact` - 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` - Stablecoin
                * `kakao_pay` - Kakao Pay
                * `naver_pay` - Naver Pay
                * `revolut_pay` - Revolut Pay
                * `cash_app_pay` - Cash App Pay
                * `pix` - Payments made via Pix
                * `twint` - Twint
                * `go_pay` - Go Pay
                * `grab_pay` - Grab Pay
                * `pay_co` - Pay Co
                * `after_pay` - After Pay
                * `swish` - Swish
                * `payme` - PayMe
                * `klarna` - Payments made via Klarna
                * `alipay_hk` - Alipay HK
                * `paypay` - PayPay
                * `gcash` - GCash
                * `south_korean_cards` - Payments made via South Korean Cards
                * `paynow` - Payments made via PayNow
                * `bizum` - Payments made via Bizum
                * `promptpay` - Payments made via PromptPay
                * `dana` - Dana
                * `touch_n_go` - Touch 'n Go
                * `tamara` - Tamara
                * `qpay` - Qpay
                * `ovo` - OVO
                * `momo` - MoMo
                * `mercado_pago` - Mercado Pago
                * `nequi` - Nequi
                * `nupay` - NuPay
                * `picpay` - PicPay
                * `thai_qr` - Thai QR
                * `blik` - BLIK
                * `fpx` - FPX
                * `wero` - Wero
                * `p24` - Przelewy24 (P24)
                * `affirm_pay` - Affirm Pay
                * `rakuten_pay` - Rakuten Pay
              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
              - alipay_hk
              - paypay
              - gcash
              - south_korean_cards
              - paynow
              - bizum
              - promptpay
              - dana
              - touch_n_go
              - tamara
              - qpay
              - ovo
              - momo
              - mercado_pago
              - nequi
              - nupay
              - picpay
              - thai_qr
              - blik
              - fpx
              - wero
              - p24
              - affirm_pay
              - rakuten_pay
              example: null
            is_not:
              type: string
              description: |
                * `card` - Card
                * `cash` - Cash
                * `check` - Check
                * `chargeback` - Only applicable for a transaction of [type](transactions#transaction_type) = `refund`. This value is set by Chargebee when an automated [chargeback](https://www.chargebee.com/docs/chargeback.html#chargeback-process) occurs. You can also set this explicitly when [recording a refund](transactions#record_an_offline_refund).
                * `bank_transfer` - Bank Transfer
                * `amazon_payments` - Amazon Payments
                * `paypal_express_checkout` - Paypal Express Checkout
                * `direct_debit` - Direct Debit
                * `alipay` - Alipay
                * `unionpay` - Unionpay
                * `apple_pay` - Apple Pay
                * `wechat_pay` - WeChat Pay
                * `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
                * `pay_to` - PayTo
                * `faster_payments` - Faster Payments
                * `sepa_instant_transfer` - Sepa Instant Transfer
                * `automated_bank_transfer` - Automated Bank Transfer
                * `klarna_pay_now` - Klarna Pay Now
                * `online_banking_poland` - Online Banking Poland
                * `payconiq_by_bancontact` - 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` - Stablecoin
                * `kakao_pay` - Kakao Pay
                * `naver_pay` - Naver Pay
                * `revolut_pay` - Revolut Pay
                * `cash_app_pay` - Cash App Pay
                * `pix` - Payments made via Pix
                * `twint` - Twint
                * `go_pay` - Go Pay
                * `grab_pay` - Grab Pay
                * `pay_co` - Pay Co
                * `after_pay` - After Pay
                * `swish` - Swish
                * `payme` - PayMe
                * `klarna` - Payments made via Klarna
                * `alipay_hk` - Alipay HK
                * `paypay` - PayPay
                * `gcash` - GCash
                * `south_korean_cards` - Payments made via South Korean Cards
                * `paynow` - Payments made via PayNow
                * `bizum` - Payments made via Bizum
                * `promptpay` - Payments made via PromptPay
                * `dana` - Dana
                * `touch_n_go` - Touch 'n Go
                * `tamara` - Tamara
                * `qpay` - Qpay
                * `ovo` - OVO
                * `momo` - MoMo
                * `mercado_pago` - Mercado Pago
                * `nequi` - Nequi
                * `nupay` - NuPay
                * `picpay` - PicPay
                * `thai_qr` - Thai QR
                * `blik` - BLIK
                * `fpx` - FPX
                * `wero` - Wero
                * `p24` - Przelewy24 (P24)
                * `affirm_pay` - Affirm Pay
                * `rakuten_pay` - Rakuten Pay
              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
              - alipay_hk
              - paypay
              - gcash
              - south_korean_cards
              - paynow
              - bizum
              - promptpay
              - dana
              - touch_n_go
              - tamara
              - qpay
              - ovo
              - momo
              - mercado_pago
              - nequi
              - nupay
              - picpay
              - thai_qr
              - blik
              - fpx
              - wero
              - p24
              - affirm_pay
              - rakuten_pay
              example: null
            in:
              type: string
              description: |
                * `card` - Card
                * `cash` - Cash
                * `check` - Check
                * `chargeback` - Only applicable for a transaction of [type](transactions#transaction_type) = `refund`. This value is set by Chargebee when an automated [chargeback](https://www.chargebee.com/docs/chargeback.html#chargeback-process) occurs. You can also set this explicitly when [recording a refund](transactions#record_an_offline_refund).
                * `bank_transfer` - Bank Transfer
                * `amazon_payments` - Amazon Payments
                * `paypal_express_checkout` - Paypal Express Checkout
                * `direct_debit` - Direct Debit
                * `alipay` - Alipay
                * `unionpay` - Unionpay
                * `apple_pay` - Apple Pay
                * `wechat_pay` - WeChat Pay
                * `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
                * `pay_to` - PayTo
                * `faster_payments` - Faster Payments
                * `sepa_instant_transfer` - Sepa Instant Transfer
                * `automated_bank_transfer` - Automated Bank Transfer
                * `klarna_pay_now` - Klarna Pay Now
                * `online_banking_poland` - Online Banking Poland
                * `payconiq_by_bancontact` - 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` - Stablecoin
                * `kakao_pay` - Kakao Pay
                * `naver_pay` - Naver Pay
                * `revolut_pay` - Revolut Pay
                * `cash_app_pay` - Cash App Pay
                * `pix` - Payments made via Pix
                * `twint` - Twint
                * `go_pay` - Go Pay
                * `grab_pay` - Grab Pay
                * `pay_co` - Pay Co
                * `after_pay` - After Pay
                * `swish` - Swish
                * `payme` - PayMe
                * `klarna` - Payments made via Klarna
                * `alipay_hk` - Alipay HK
                * `paypay` - PayPay
                * `gcash` - GCash
                * `south_korean_cards` - Payments made via South Korean Cards
                * `paynow` - Payments made via PayNow
                * `bizum` - Payments made via Bizum
                * `promptpay` - Payments made via PromptPay
                * `dana` - Dana
                * `touch_n_go` - Touch 'n Go
                * `tamara` - Tamara
                * `qpay` - Qpay
                * `ovo` - OVO
                * `momo` - MoMo
                * `mercado_pago` - Mercado Pago
                * `nequi` - Nequi
                * `nupay` - NuPay
                * `picpay` - PicPay
                * `thai_qr` - Thai QR
                * `blik` - BLIK
                * `fpx` - FPX
                * `wero` - Wero
                * `p24` - Przelewy24 (P24)
                * `affirm_pay` - Affirm Pay
                * `rakuten_pay` - Rakuten Pay
              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
              - alipay_hk
              - paypay
              - gcash
              - south_korean_cards
              - paynow
              - bizum
              - promptpay
              - dana
              - touch_n_go
              - tamara
              - qpay
              - ovo
              - momo
              - mercado_pago
              - nequi
              - nupay
              - picpay
              - thai_qr
              - blik
              - fpx
              - wero
              - p24
              - affirm_pay
              - rakuten_pay
              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|alipay_hk|paypay|gcash|south_korean_cards|paynow|bizum|promptpay|dana|touch_n_go|tamara|qpay|ovo|momo|mercado_pago|nequi|nupay|picpay|thai_qr|blik|fpx|wero|p24|affirm_pay|rakuten_pay)(,(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|alipay_hk|paypay|gcash|south_korean_cards|paynow|bizum|promptpay|dana|touch_n_go|tamara|qpay|ovo|momo|mercado_pago|nequi|nupay|picpay|thai_qr|blik|fpx|wero|p24|affirm_pay|rakuten_pay))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                * `card` - Card
                * `cash` - Cash
                * `check` - Check
                * `chargeback` - Only applicable for a transaction of [type](transactions#transaction_type) = `refund`. This value is set by Chargebee when an automated [chargeback](https://www.chargebee.com/docs/chargeback.html#chargeback-process) occurs. You can also set this explicitly when [recording a refund](transactions#record_an_offline_refund).
                * `bank_transfer` - Bank Transfer
                * `amazon_payments` - Amazon Payments
                * `paypal_express_checkout` - Paypal Express Checkout
                * `direct_debit` - Direct Debit
                * `alipay` - Alipay
                * `unionpay` - Unionpay
                * `apple_pay` - Apple Pay
                * `wechat_pay` - WeChat Pay
                * `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
                * `pay_to` - PayTo
                * `faster_payments` - Faster Payments
                * `sepa_instant_transfer` - Sepa Instant Transfer
                * `automated_bank_transfer` - Automated Bank Transfer
                * `klarna_pay_now` - Klarna Pay Now
                * `online_banking_poland` - Online Banking Poland
                * `payconiq_by_bancontact` - 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` - Stablecoin
                * `kakao_pay` - Kakao Pay
                * `naver_pay` - Naver Pay
                * `revolut_pay` - Revolut Pay
                * `cash_app_pay` - Cash App Pay
                * `pix` - Payments made via Pix
                * `twint` - Twint
                * `go_pay` - Go Pay
                * `grab_pay` - Grab Pay
                * `pay_co` - Pay Co
                * `after_pay` - After Pay
                * `swish` - Swish
                * `payme` - PayMe
                * `klarna` - Payments made via Klarna
                * `alipay_hk` - Alipay HK
                * `paypay` - PayPay
                * `gcash` - GCash
                * `south_korean_cards` - Payments made via South Korean Cards
                * `paynow` - Payments made via PayNow
                * `bizum` - Payments made via Bizum
                * `promptpay` - Payments made via PromptPay
                * `dana` - Dana
                * `touch_n_go` - Touch 'n Go
                * `tamara` - Tamara
                * `qpay` - Qpay
                * `ovo` - OVO
                * `momo` - MoMo
                * `mercado_pago` - Mercado Pago
                * `nequi` - Nequi
                * `nupay` - NuPay
                * `picpay` - PicPay
                * `thai_qr` - Thai QR
                * `blik` - BLIK
                * `fpx` - FPX
                * `wero` - Wero
                * `p24` - Przelewy24 (P24)
                * `affirm_pay` - Affirm Pay
                * `rakuten_pay` - Rakuten Pay
              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
              - alipay_hk
              - paypay
              - gcash
              - south_korean_cards
              - paynow
              - bizum
              - promptpay
              - dana
              - touch_n_go
              - tamara
              - qpay
              - ovo
              - momo
              - mercado_pago
              - nequi
              - nupay
              - picpay
              - thai_qr
              - blik
              - fpx
              - wero
              - p24
              - affirm_pay
              - rakuten_pay
              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|alipay_hk|paypay|gcash|south_korean_cards|paynow|bizum|promptpay|dana|touch_n_go|tamara|qpay|ovo|momo|mercado_pago|nequi|nupay|picpay|thai_qr|blik|fpx|wero|p24|affirm_pay|rakuten_pay)(,(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|alipay_hk|paypay|gcash|south_korean_cards|paynow|bizum|promptpay|dana|touch_n_go|tamara|qpay|ovo|momo|mercado_pago|nequi|nupay|picpay|thai_qr|blik|fpx|wero|p24|affirm_pay|rakuten_pay))*\\\
                ]$"
              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, payu, not_applicable.

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

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

          The reference number for this transaction. For example, the check number when [payment_method](/docs/api/transactions/transaction-object#payment_method)
          = `check`
          .
          **Supported operators :**
          is, is_not, starts_with, is_present

          **Example →**
          *reference_number\[is\] = "cus_u239732"*
        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_not\] = "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 [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources).
                * `payment` - The transaction represents capture of [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources).
                * `refund` - The transaction represents a refund of [amount](transactions#transaction_amount) to the customer's [payment_source](payment_sources).
                * `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 [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources).
                * `payment` - The transaction represents capture of [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources).
                * `refund` - The transaction represents a refund of [amount](transactions#transaction_amount) to the customer's [payment_source](payment_sources).
                * `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 [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources).
                * `payment` - The transaction represents capture of [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources).
                * `refund` - The transaction represents a refund of [amount](transactions#transaction_amount) to the customer's [payment_source](payment_sources).
                * `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 [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources).
                * `payment` - The transaction represents capture of [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources).
                * `refund` - The transaction represents a refund of [amount](transactions#transaction_amount) to the customer's [payment_source](payment_sources).
                * `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.
          We recommend using this filter when listing transactions for better query performance. It is advisable when using this filter, to pass the `sort_by`
          input parameter as `date`
          for a faster response.
          **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\[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_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\[lt\] = "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\] = "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: |
          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. It is advisable when using this filter, to pass the `sort_by`
          input parameter as `updated_at`
          for a faster response.
          **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, 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: |
                            Resource object representing transaction
                      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:
      tags:
      - transactions
      summary: Reconcile transaction
      description: |
        Update selected attributes of the transaction resource: `status`, `id_at_gateway`, and `customer_id`. Use this API for reconciliation purposes where the status of a transaction is in [needs_attention](/docs/api/transactions/transaction-object#status) that can be updated to either [success](/docs/api/transactions/transaction-object#status) or [failure](/docs/api/transactions/transaction-object#status) status.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: "The identifier with which this transaction is referred\
                    \ in gateway. The `id_at_gateway`\ncan only be updated when the\
                    \ transaction status is in [needs_attention](/docs/api/transactions/transaction-object#status).\
                    \  \n**Note**:\n\n* It is mandatory to pass this parameter value\
                    \ for updating the transaction status from `needs_attention` to\
                    \ `success`. It is recommended to pass this value if available\
                    \ in the gateway.\n* An error occurs when the provided `id_at_gateway`\
                    \ value does not match the `id_at_gateway` value stored against\
                    \ the transaction in Chargebee.\n"
                  maxLength: 100
                  example: null
                customer_id:
                  type: string
                  deprecated: false
                  description: "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.  \n**Note**:\n\nAn error\
                    \ occurs when the provided `customer_id`\nvalue does not match\
                    \ the `customer_id`\nvalue stored against the transaction in Chargebee.\n"
                  maxLength: 50
                  example: null
                status:
                  type: string
                  deprecated: false
                  description: "The status of this transaction. The status can only\
                    \ be updated when the transaction status is in [needs_attention](/docs/api/transactions/transaction-object#status)\n\
                    state.\n\n* failure -\n  When the transaction is in failure status.\
                    \  \n  **Note**:\n\n  When the transaction is updated to [failure](/docs/api/transactions/transaction-object#status)\
                    \ status and the invoice is associated with the transaction,\n\
                    \n  * the invoice will be moved to the [payment_due](/docs/api/invoices/invoice-object#status)\
                    \ status if the [dunning](https://www.chargebee.com/docs/payments/2.0/dunning-v2.html)\
                    \ is configured.\n  * the invoice will be moved to the [not_paid](/docs/api/invoices/invoice-object#status)\
                    \ status if the [dunning](https://www.chargebee.com/docs/payments/2.0/dunning-v2.html)\
                    \ is not configured.\n* success -\n  When the transaction is successful.\
                    \  \n  **Note**:\n\n  When the transaction is updated to [success](/docs/api/transactions/transaction-object#status)\n\
                    \  status, - and the invoice is associated with the transaction,\
                    \ the transaction [amount](/docs/api/transactions/transaction-object#amount)\
                    \ will be applied to the invoice.\n\n  * and no invoice is associated\
                    \ but the customer is associated with the transaction, [customer_excess_payments](/docs/api/customers/customer-object#excess_payments)\
                    \ will be updated.\n"
                  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: |
                      Resource object representing transaction
                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:
      tags:
      - transactions
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing transaction
                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:
      tags:
      - transactions
      summary: Refund a payment
      description: "Refunds an online payment. Applicable only for `transaction`s\
        \ of [type](/docs/api/transactions/transaction-object#type) = `payment`. You\
        \ can only refund a `transaction` whose [status](/docs/api/transactions/transaction-object#status)\
        \ is `success`.  \n* Not supported for ach_credit, sepa_credit, cash, check,\
        \ bank_transfer, other.\n* 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)\
        \ to enable this endpoint.\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    The amount to be refunded. Must not exceed [amount_unused](/docs/api/transactions/transaction-object#amount_unused).
                    If not passed then all of [amount_unused](/docs/api/transactions/transaction-object#amount_unused)
                    is refunded.
                  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: |
                      Resource object representing transaction
                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:
      tags:
      - transactions
      summary: Record an offline refund
      description: |
        Records a refund made offline. Applicable only for `transaction`s of [type](/docs/api/transactions/transaction-object#type) = `payment`.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    The amount to be recorded as refunded. Must not exceed [amount_unused](/docs/api/transactions/transaction-object#amount_unused).
                    If not passed then all of [amount_unused](/docs/api/transactions/transaction-object#amount_unused)
                    is recorded as refunded.
                  minimum: 1
                  example: null
                payment_method:
                  type: string
                  deprecated: false
                  description: |
                    The payment method used to make the refund.

                    * check - Check
                    * cash - Cash
                    * custom - Custom
                    * chargeback -
                      Only applicable for a transaction of [type](/docs/api/transactions/transaction-object#type)
                      = `refund`.
                      This value is set by Chargebee when an automated [chargeback](https://www.chargebee.com/docs/chargeback.html#chargeback-process)
                      occurs. You can also set this explicitly when [recording a refund](/docs/api/transactions/record-an-offline-refund)
                      .
                    * other - Payment Methods other than the above types
                    * bank_transfer - Bank Transfer
                  enum:
                  - cash
                  - check
                  - chargeback
                  - bank_transfer
                  - other
                  - custom
                  - tamara
                  - qpay
                  - blik
                  - fpx
                  - wero
                  - p24
                  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: |
                    The reference number for this transaction. For example, the check number when `payment_method`
                    = `check`
                    .
                  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: |
                      Resource object representing transaction
                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:
      tags:
      - transactions
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing transaction
                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:
      tags:
      - transactions
      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/2.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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing transaction
                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:
      tags:
      - invoices
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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: |
                            Resource object representing transaction
                      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:
      tags:
      - transactions
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing transaction
                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: []
  /disputes/{dispute-id}:
    get:
      tags:
      - disputes
      summary: Retrieve a dispute
      operationId: retrieve_a_dispute
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: dispute-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/dispute-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  dispute:
                    $ref: "#/components/schemas/Dispute"
                    description: Resource object representing dispute
                required:
                - dispute
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /disputes:
    get:
      tags:
      - disputes
      summary: List disputes
      operationId: list_disputes
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - 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: id
        in: query
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          description: Identifier for Dispute.
          example: dspt_16BdDXSlbu4uV1Ee6
          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
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          description: The current state of the dispute.
          example: initiated
          properties:
            is:
              type: string
              description: |-
                * `initiated` - The dispute has been raised by the cardholder and the funds are yet to be withdrawn.
                * `funds_withdrawn` - The gateway has withdrawn the disputed amount pending resolution.
                * `in_review` - Evidence has been submitted and the dispute is being reviewed.
                * `cancelled` - The dispute was withdrawn before it was resolved.
                * `lost` - The dispute was resolved in the cardholder's favour.
                * `won` - The dispute was resolved in the merchant's favour.
              enum:
              - initiated
              - funds_withdrawn
              - in_review
              - cancelled
              - lost
              - won
              example: null
            is_not:
              type: string
              description: |-
                * `initiated` - The dispute has been raised by the cardholder and the funds are yet to be withdrawn.
                * `funds_withdrawn` - The gateway has withdrawn the disputed amount pending resolution.
                * `in_review` - Evidence has been submitted and the dispute is being reviewed.
                * `cancelled` - The dispute was withdrawn before it was resolved.
                * `lost` - The dispute was resolved in the cardholder's favour.
                * `won` - The dispute was resolved in the merchant's favour.
              enum:
              - initiated
              - funds_withdrawn
              - in_review
              - cancelled
              - lost
              - won
              example: null
            in:
              type: string
              description: |-
                * `initiated` - The dispute has been raised by the cardholder and the funds are yet to be withdrawn.
                * `funds_withdrawn` - The gateway has withdrawn the disputed amount pending resolution.
                * `in_review` - Evidence has been submitted and the dispute is being reviewed.
                * `cancelled` - The dispute was withdrawn before it was resolved.
                * `lost` - The dispute was resolved in the cardholder's favour.
                * `won` - The dispute was resolved in the merchant's favour.
              enum:
              - initiated
              - funds_withdrawn
              - in_review
              - cancelled
              - lost
              - won
              pattern: "^\\[(initiated|funds_withdrawn|in_review|cancelled|lost|won)(,(initiated|funds_withdrawn|in_review|cancelled|lost|won))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |-
                * `initiated` - The dispute has been raised by the cardholder and the funds are yet to be withdrawn.
                * `funds_withdrawn` - The gateway has withdrawn the disputed amount pending resolution.
                * `in_review` - Evidence has been submitted and the dispute is being reviewed.
                * `cancelled` - The dispute was withdrawn before it was resolved.
                * `lost` - The dispute was resolved in the cardholder's favour.
                * `won` - The dispute was resolved in the merchant's favour.
              enum:
              - initiated
              - funds_withdrawn
              - in_review
              - cancelled
              - lost
              - won
              pattern: "^\\[(initiated|funds_withdrawn|in_review|cancelled|lost|won)(,(initiated|funds_withdrawn|in_review|cancelled|lost|won))*\\\
                ]$"
              example: null
      - name: type
        in: query
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          description: The nature of the dispute raised against the payment.
          example: chargeback
          properties:
            is:
              type: string
              description: |-
                * `chargeback` - A formal reversal of the payment raised through the card network.
                * `inquiry` - A pre-dispute inquiry raised by the issuer before a chargeback.
              enum:
              - chargeback
              - inquiry
              example: null
            is_not:
              type: string
              description: |-
                * `chargeback` - A formal reversal of the payment raised through the card network.
                * `inquiry` - A pre-dispute inquiry raised by the issuer before a chargeback.
              enum:
              - chargeback
              - inquiry
              example: null
            in:
              type: string
              description: |-
                * `chargeback` - A formal reversal of the payment raised through the card network.
                * `inquiry` - A pre-dispute inquiry raised by the issuer before a chargeback.
              enum:
              - chargeback
              - inquiry
              pattern: "^\\[(chargeback|inquiry)(,(chargeback|inquiry))*\\]$"
              example: null
            not_in:
              type: string
              description: |-
                * `chargeback` - A formal reversal of the payment raised through the card network.
                * `inquiry` - A pre-dispute inquiry raised by the issuer before a chargeback.
              enum:
              - chargeback
              - inquiry
              pattern: "^\\[(chargeback|inquiry)(,(chargeback|inquiry))*\\]$"
              example: null
      - name: customer_id
        in: query
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          description: Identifier of the customer whose payment was disputed.
          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: transaction_id
        in: query
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          description: Identifier of the transaction that was disputed.
          example: txn_16BdDXSlbu4uV1Ee6
          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: amount
        in: query
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          description: |
            The amount under dispute. The unit depends on the [type of currency](/docs/api#md_disabled).
          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: created_at
        in: query
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          description: Timestamp indicating when the dispute 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
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        dispute:
                          $ref: "#/components/schemas/Dispute"
                          description: Resource object representing dispute
                      required:
                      - dispute
                      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_for_items:
    post:
      tags:
      - hosted_pages
      summary: Checkout charge-items and one-time charges
      description: |
        Create a Chargebee hosted page to accept payment details from a customer and checkout [charge-items](/docs/api/items) and [one-time charges](/docs/api/invoices/create-invoice-for-items-and-one-time-charges).

        The following steps describe how best to use this API:

        1. Call this endpoint, providing [item prices](/docs/api/item_prices), [charges](/docs/api/items), [coupons](/docs/api/coupons) and a host of other details such as billing and shipping addresses of the customer, to be prefilled on the checkout page. You may also provide `pass_thru_content` containing information and IDs from your systems that must be associated with the checkout page.
        2. Send the customer to the Checkout `url` received in the response.
        3. Once they complete checkout, the set of charge-items and one-time charges are automatically invoiced against the respective `customer` record in Chargebee, and they are redirected to the `redirect_url` with the `id` and `state` attributes passed as query string parameters.
        4. [Retrieve the hosted page](/docs/api/hosted_pages/retrieve-a-hosted-page) at this stage to get the invoice details.

        #### Customer resource lookup and creation

        When [customer[id]](/docs/api/hosted_pages/checkout-charge-items-and-one-time-charges) is provided for this operation, it is looked up by Chargebee, and if found, the hosted_page is created for it. If not found, a new customer resource is created with an autogenarated ID, and the hosted_page is created.

        ##### Multiple business entities

        If multiple [business entities](/docs/api/advanced-features) are created for the site, the customer resource lookup and creation happen within the [context](/docs/api/advanced-features) of the business entity [specified](/docs/api/advanced-features#mbe-header-main) in this API call. If no business entity is specified, the customer resource lookup is performed within the [site context](/docs/api/advanced-features) , and if not found, the resource is created for the [default business entity](/docs/api/advanced-features) of the site.
      operationId: checkout_charge-items_and_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                business_entity_id:
                  type: string
                  deprecated: false
                  description: "Sets the [context]() for this operation to the [business\
                    \ entity](/docs/api/advanced-features) specified. Applicable only\
                    \ when multiple business entities have been created for the site.\
                    \ When this parameter is provided, the operation is able to read/write\
                    \ data associated only to the business entity specified. When\
                    \ not provided, the operation can read/write data for the entire\
                    \ site.  \n**Note**\n\nAn alternative way of passing this parameter\
                    \ is by means of a [custom HTTP header](/docs/api/advanced-features).\
                    \  \n**See also**\n[Customer resource lookup and creation.](/docs/api/hosted_pages)\n"
                  maxLength: 50
                  example: null
                brand_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [brand](/docs/api/brands) this\
                    \ hosted page should be linked to. Applicable only when multiple\
                    \ brands have been created for the site. Resources created through\
                    \ the hosted page, such as the customer and the subscription,\
                    \ are linked to the same brand. An alternative way of passing\
                    \ this parameter is by means of the `chargebee-brand-id` custom\
                    \ HTTP header; when both are provided, they must specify the same\
                    \ brand.  \n**Default behavior**\n\n* When not provided, the brand\
                    \ of the customer or subscription referenced in the request is\
                    \ used, or the default brand defined for the site when the request\
                    \ references neither.\n"
                  maxLength: 50
                  example: null
                layout:
                  type: string
                  deprecated: false
                  description: |
                    Specifies the UI layout for the hosted page. This overrides [the layout](https://www.chargebee.com/docs/billing/2.0/hosted-capabilities/hosted-checkout#ui-layout-options) configured in Chargebee Billing.

                    * in_app - Renders the hosted page in an in-app layout.
                    * full_page - Renders the hosted page in a full-page layout.
                  enum:
                  - in_app
                  - full_page
                  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: |
                    List of Coupons to be added.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The currency code (ISO 4217 format) of the invoice amount.
                  maxLength: 3
                  example: null
                redirect_url:
                  type: string
                  deprecated: false
                  description: |
                    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.

                    **Note** :

                    * Although the customer will be redirected to the `redirect_url` 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 [`subscription_created`](/docs/api/events) or [`invoice_generated`](/docs/api/events) to verify a successful checkout.
                    * Redirect URL configured in Settings \> Hosted Pages Settings would be overriden by this redirect URL.
                    * *Eg :* *http://yoursite.com?id=\*\*\&state=succeeded*
                    * This parameter is not applicable for iframe messaging.
                  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: |
                    This attribute allows you to store custom information with the `hosted_page` 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 [redirect URL](/docs/api/hosted_pages/checkout-charge-items-and-one-time-charges)'s query parameters. Using this ID, you can fetch the hosted page and perform actions related to the success of the marketing campaign.
                  maxLength: 2048
                  example: null
                customer:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    Parameters for customer
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: "The unique ID of the customer for which this `hosted_page`\
                        \ should be created. If not provided, the ID of the newly\
                        \ created customer resource is autogenerated.  \n**See also**\n\
                        [Customer resource lookup and creation.](/docs/api/hosted_pages)\n"
                      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: |
                        Specifies if the customer is liable for tax

                        * exempt -
                          * Customer is exempted from tax. When using Chargebee's native [Taxes](https://www.chargebee.com/docs/tax.html) feature or when using the [TaxJar integration](https://www.chargebee.com/docs/taxjar.html), no other action is needed.
                          * However, when using our [Avalara integration](https://www.chargebee.com/docs/avalara.html), optionally, specify `entity_code` or `exempt_number` attributes if you use Chargebee's [AvaTax for Sales](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption) or specify `exemption_details` attribute if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. Tax may still be applied by Avalara for certain values of `entity_code`/`exempt_number`/`exemption_details` based on the state/region/province of the taxable address.
                        * taxable -
                          Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html).
                          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.
                      enum:
                      - taxable
                      - exempt
                      - zero_rated
                      example: null
                    vat_number:
                      type: string
                      deprecated: false
                      description: |
                        The VAT/tax registration number for the customer. For customers with [billing_address](/docs/api/customers/customer-object#billing_address)

                        `country`
                        as
                        `XI`
                        (which is **United Kingdom - Northern Ireland**
                        ), the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number)
                        can be overridden by setting
                        [vat_number_prefix](/docs/api/customers/customer-object#vat_number_prefix)
                        .
                      maxLength: 20
                      example: null
                    vat_number_prefix:
                      type: string
                      deprecated: false
                      description: |
                        An overridden value for the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number).
                        Only applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)

                        `country`
                        as `XI`
                        (which is **United Kingdom - Northern Ireland**
                        ).

                        When you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)
                        in 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)
                        the Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)

                        `country`
                        as `XI`.
                        That's the code for **United Kingdom - Northern Ireland** .
                        The first two characters of the VAT number in such a case is
                        `XI`
                        by default. However, if the VAT number was registered in UK, the value should be `GB`.
                        Set
                        `vat_number_prefix`
                        to `GB`
                        for such cases.
                      maxLength: 10
                      example: null
                    einvoicing_method:
                      type: string
                      deprecated: false
                      description: |
                        Determines whether e-invoices are sent manually or automatically.

                        * manual - When `manual` is selected, automatic e-invoice sending is disabled. Use this value to send e-invoices manually through the UI or the API.
                        * automatic - Use this value to send an e-invoice every time an invoice or credit note is created.
                        * site_default - The default value of the site, which can be overridden at the customer level.
                      enum:
                      - automatic
                      - manual
                      - site_default
                      example: null
                    is_einvoice_enabled:
                      type: boolean
                      deprecated: false
                      description: "Determines whether the customer is e-invoiced.\
                        \ When set to `true`\nor not set to any value, the customer\
                        \ is e-invoiced so long as e-invoicing is enabled for their\
                        \ country (`billing_address.country`\n). When set to `false`\n\
                        , the customer is not e-invoiced even if e-invoicing is enabled\
                        \ for their country.  \n**Tip:**\n\nIt 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.\n"
                      example: null
                    entity_identifier_scheme:
                      type: string
                      deprecated: false
                      description: "The Peppol BIS scheme associated with the [vat_number](/docs/api/customers/customer-object#vat_number)\n\
                        of the customer. This helps identify the specific type of\
                        \ customer entity. For example, `DE:VAT`\nis used for a German\
                        \ business entity while `DE:LWID45`\nis used for a German\
                        \ government entity. The value must be from the list of possible\
                        \ values and must correspond to the country provided under\
                        \ `billing_address.country`.\nSee [list of possible values](https://www.chargebee.com/docs/e-invoicing.html#supported-countries)\n\
                        .  \n**Tip:**\n\nIf there are additional entity identifiers\
                        \ for the customer not associated with the `vat_number`, they\
                        \ can be provided as the `entity_identifiers[]` array.\n"
                      maxLength: 50
                      example: null
                    entity_identifier_standard:
                      type: string
                      default: iso6523-actorid-upis
                      deprecated: false
                      description: "The standard used for specifying the `entity_identifier_scheme`.\n\
                        Currently only `iso6523-actorid-upis`\nis supported and is\
                        \ used by default when not provided.  \n**Tip:**\n\nIf there\
                        \ are additional entity identifiers for the customer not associated\
                        \ with the `vat_number`, they can be provided as the `entity_identifiers[]`\
                        \ array.\n"
                      maxLength: 50
                      example: null
                    consolidated_invoicing:
                      type: boolean
                      deprecated: false
                      description: "Indicates whether invoices raised on the same\
                        \ day for the `customer` are consolidated. When provided,\
                        \ this overrides the default configuration at the [site-level](https://www.chargebee.com/docs/consolidated-invoicing.html#configuring-consolidated-invoicing).\
                        \ This parameter can be provided only when [Consolidated Invoicing](https://www.chargebee.com/docs/consolidated-invoicing.html)\
                        \ is enabled.  \n**Note:**\n\nAny invoices raised when a subscription\
                        \ activates from `in_trial` or `future` `status`, are not\
                        \ consolidated by default. [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 enable consolidation for such invoices.\n"
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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
                item_prices:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_prices
                  properties:
                    item_price_id:
                      type: array
                      description: "A unique ID of the [item price](/docs/api/item_prices/item_price-object)\
                        \ to be added to the invoice.  \n**Constraints**\n\nThe item\
                        \ price must have `item_type` set to `charge`.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Item price quantity
                      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 item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        The price or per-unit-price of the item price. By default, it is the [value set](/docs/api/item_prices/item_price-object#price)
                        for the `item_price`.
                        This is only applicable when the `pricing_model`
                        of the `item_price`
                        is `flat_fee`
                        or `per_unit`.
                        The value depends on the [type of currency](/docs/api/currencies)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      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/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 item 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 item ends.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
                item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_tiers
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The id of the item price to which this tier belongs.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: |
                        The lowest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The highest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |
                        The per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        The total cost for the item price when the `pricing_model`
                        is `stairstep`.
                        The value is in the minor unit of the currency.
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    pricing_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Pricing type for the tier.

                          * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                          * flat_fee -
                            Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                            pricing model, `pricing_type`
                            will be set to `flat_fee`
                            by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                          * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                        enum:
                        - per_unit
                        - flat_fee
                        - package
                        example: null
                      example: null
                    package_size:
                      type: array
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        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/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
                          * 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
                          * 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
                discounts:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for discounts
                  properties:
                    percentage:
                      type: array
                      description: |
                        The percentage of the original amount that should be deducted from it.
                      items:
                        type: number
                        format: double
                        deprecated: false
                        maximum: 100
                        minimum: 0.01
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        The value of the discount. [The format of this value](/docs/api/currencies)
                        depends on the kind of currency.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Specifies the number of free units provided for the item, without affecting the total quantity sold
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    apply_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The amount on the invoice to which the discount is applied.

                          * invoice_amount -
                            The discount is applied to the invoice `sub_total`
                            .
                          * specific_item_price -
                            The discount is applied to the `invoice.line_item.amount`
                            that corresponds to the item price specified by `item_price_id`
                            .
                        enum:
                        - invoice_amount
                        - specific_item_price
                        example: null
                      example: null
                    item_price_id:
                      type: array
                      description: |
                        The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                        in the subscription to which the discount is to be applied. Relevant only when `apply_on`
                        = `specific_item_price`.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                  required:
                  - apply_on
                  example: null
                entity_identifiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for entity_identifiers
                  properties:
                    id:
                      type: array
                      description: |
                        The unique id for the `entity_identifier[i]`
                        in Chargebee. This is required when `entity_identifier[operation][i]`
                        is `update`
                        or `delete`
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    scheme:
                      type: array
                      description: "The Peppol BIS scheme associated with the [vat_number](/docs/api/customers/customer-object#vat_number)\n\
                        of the customer. This helps identify the specific type of\
                        \ customer entity. For example, `DE:VAT`\nis used for a German\
                        \ business entity while `DE:LWID45`\nis used for a German\
                        \ government entity. The value must be from the list of possible\
                        \ values and must correspond to the country provided under\
                        \ `billing_address.country`.\nSee [list of possible values](https://www.chargebee.com/docs/e-invoicing.html#supported-countries)\n\
                        .  \n**Tip:**\n\nIf there is only one entity identifier for\
                        \ the customer and the value is the same as `vat_number`,\
                        \ then there is no need to provide the `entity_identifiers[]`\
                        \ array. See [description for `entity_identifiers[]`](/docs/api/customers/customer-object#entity_identifiers).\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    value:
                      type: array
                      description: "The value of the `entity_identifier`.\nThis identifies\
                        \ the customer entity on the Peppol network. For example:\
                        \ `10101010-STO-10`\n.  \n**Tip:**\n\nIf there is only one\
                        \ entity identifier for the customer and the value is the\
                        \ same as `vat_number`, then there is no need to provide the\
                        \ `entity_identifiers[]` array. See [description for `entity_identifiers[]`](/docs/api/customers/customer-object#entity_identifiers).\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    operation:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The operation to be performed for the `entity_identifier`
                          .

                          * create -
                            Creates a new `entity_identifier`
                            for the customer.
                          * update -
                            Updates an existing `entity_identifier`
                            for the customer. `entity_identifier[id]`
                            must be provided in this case.
                          * delete -
                            Deletes an existing `entity_identifier`
                            for the customer. `entity_identifier[id]`
                            must be provided in this case.
                        enum:
                        - create
                        - update
                        - delete
                        example: null
                      example: null
                    standard:
                      type: array
                      description: "The standard used for specifying the `entity_identifier`\n\
                        `scheme`.\nCurrently, only `iso6523-actorid-upis`\nis supported\
                        \ and is used by default when not provided.  \n**Tip:**\n\n\
                        If there is only one entity identifier for the customer and\
                        \ the value is the same as `vat_number`, then there is no\
                        \ need to provide the `entity_identifiers[]` array. See [description\
                        \ for `entity_identifiers[]`](/docs/api/customers/customer-object#entity_identifiers).\n"
                      items:
                        type: string
                        default: iso6523-actorid-upis
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              billing_address:
                style: deepObject
                explode: true
              card:
                style: deepObject
                explode: true
              charges:
                style: deepObject
                explode: true
              customer:
                style: deepObject
                explode: true
              discounts:
                style: deepObject
                explode: true
              entity_identifiers:
                style: deepObject
                explode: true
              invoice:
                style: deepObject
                explode: true
              item_prices:
                style: deepObject
                explode: true
              item_tiers:
                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: |
                      Resource object representing hosted_page
                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:
      tags:
      - hosted_pages
      summary: Extend subscription
      description: |
        This API generates a hosted page URL to extend the billing cycle of a subscription.

        Use one of the following methods to open the hosted page:

        * **In-app modal** : Use Chargebee.js [`openCheckout()`](https://www.chargebee.com/checkout-portal-docs/cbinstanceobj-api-ref.html#opencheckout-options) to open the hosted page in a modal popup in your website or application.
        * **Standalone page** : Redirect the customer to the hosted page `url`.

        Do not embed the hosted page in your own [iframe](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/iframe).
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                brand_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [brand](/docs/api/brands) this\
                    \ hosted page should be linked to. Applicable only when multiple\
                    \ brands have been created for the site. This need not match the\
                    \ brand of the customer or subscription in the request; when the\
                    \ two differ, the value provided here is used for the hosted page.\
                    \ An alternative way of passing this parameter is by means of\
                    \ the `chargebee-brand-id` custom HTTP header; when both are provided,\
                    \ they must specify the same brand.  \n**Default behavior**\n\n\
                    * When not provided, the hosted page is linked to the brand of\
                    \ the customer or subscription in the request.\n"
                  maxLength: 50
                  example: null
                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: "The number of billing cycles by which the subscription\
                    \ should be extended.  \n**Default behavior**\n\n* If the subscription's\
                    \ plan has [`billing_cycles`](/docs/api/item_prices#billing_cycles)\
                    \ set, that value is used.\n* If the plan's billing cycles attribute\
                    \ is not set, `1` is used.\n"
                  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: |
                      Resource object representing hosted_page
                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:
      tags:
      - hosted_pages
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    The meta data description of the event in key-value pair. The value is a JSON object with the following keys and their values.

                    * `subscription_id`: A unique and immutable identifier for the subscription. .
                  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
                    description: |
                      Event was processed successfully.
                    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/checkout_gift_for_items:
    post:
      tags:
      - hosted_pages
      summary: Checkout gift subscription for items
      description: |
        Creates a hosted page for a customer (called the gifter) to gift a subscription to another customer (called the receiver).

        #### Gifter customer resource lookup and creation

        When [gifter[customer_id]](/docs/api/hosted_pages/checkout-gift-subscription-for-items#gifter_customer_id) 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.

        ##### Multiple business entities

        If multiple [business entities](/docs/api/advanced-features) are created for the site, the lookup and creation of the gifter customer resource happen within the [context](/docs/api/advanced-features) of the business entity specified in this API call. If no business entity is [specified](/docs/api/advanced-features#mbe-header-main), the customer resource lookup is performed within the [site context](/docs/api/advanced-features), and if not found, the resource is created for the [default business entity](/docs/api/advanced-features) of the site.

        #### Gift receiver customer resource lookup and creation

        Once the gifter checks out using the hosted page returned by this endpoint, Chargebee checks if a customer resource with the receiver's email address exists. The first such customer record is considered the receiver's customer resource. A new customer resource is created for the receiver if none are found.

        ##### Multiple business entities

        If multiple [business entities](/docs/api/advanced-features) are created for the site, the lookup and creation of the gift receiver's customer resource happen within the [context](/docs/api/advanced-features) of the business entity of the gifter
      operationId: checkout_gift_subscription_for_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                layout:
                  type: string
                  deprecated: false
                  description: |
                    Specifies the UI layout for the hosted page. This overrides [the layout](https://www.chargebee.com/docs/billing/2.0/hosted-capabilities/hosted-checkout#ui-layout-options) configured in Chargebee Billing.

                    * in_app - Renders the hosted page in an in-app layout.
                    * full_page - Renders the hosted page in a full-page layout.
                  enum:
                  - in_app
                  - full_page
                  example: null
                business_entity_id:
                  type: string
                  deprecated: false
                  description: "Sets the [context]() for this operation to the [business\
                    \ entity](/docs/api/advanced-features) specified. Applicable only\
                    \ when multiple business entities have been created for the site.\
                    \ When this parameter is provided, the operation is able to read/write\
                    \ data associated only to the business entity specified. When\
                    \ not provided, the operation can read/write data for the entire\
                    \ site.  \n**Note**\n\nAn alternative way of passing this parameter\
                    \ is by means of a [custom HTTP header](/docs/api/advanced-features).\
                    \  \n**See also**\n\nGifter customer resource lookup and creation.\n"
                  maxLength: 50
                  example: null
                brand_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [brand](/docs/api/brands) this\
                    \ hosted page should be linked to. Applicable only when multiple\
                    \ brands have been created for the site. Resources created through\
                    \ the hosted page, such as the customer and the subscription,\
                    \ are linked to the same brand. An alternative way of passing\
                    \ this parameter is by means of the `chargebee-brand-id` custom\
                    \ HTTP header; when both are provided, they must specify the same\
                    \ brand.  \n**Default behavior**\n\n* When not provided, the brand\
                    \ of the customer or subscription referenced in the request is\
                    \ used, or the default brand defined for the site when the request\
                    \ references neither.\n"
                  maxLength: 50
                  example: null
                redirect_url:
                  type: string
                  deprecated: false
                  description: |
                    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.

                    **Note** :

                    * Although the customer will be redirected to the `redirect_url` 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 [`subscription_created`](/docs/api/events) or [`invoice_generated`](/docs/api/events) to verify a successful checkout.
                    * Redirect URL configured in Settings \> Hosted Pages Settings would be overriden by this redirect URL.
                    * *Eg :* *http://yoursite.com?id=\*\*\&state=succeeded*
                    * This parameter is not applicable for iframe messaging.
                  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: "The customer ID of the gifter. If not provided,\
                        \ the gifter customer resource is created with an autogenerated\
                        \ ID on checkout.  \n**See also**\n[Gifter customer resource\
                        \ lookup and creation](/docs/api/hosted_pages)\n"
                      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_items:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription_items
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The unique identifier of the item price.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        The quantity of the item purchased
                      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 item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: "The price/per unit price of the item. The value\
                        \ is interpreted as per the type of [currency](/docs/api/currencies).\
                        \  \n**Prerequisites**\n\n* The `pricing_model` of the item\
                        \ price is `flat_fee` or `per_unit`.\n* [Price overriding](https://www.chargebee.com/docs/price-override.html)\
                        \ is enabled for the site.  \n**Default value**\n\n* [`item_price.price`](/docs/api/item_prices/item_price-object#price).\n"
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: "The price/per unit price of the item in major\
                        \ units of the [currency](/docs/api/currencies). When not\
                        \ provided, the [value set for the item price](/docs/api/item_prices/item_price-object#price)\
                        \ is used.  \n**Prerequisites**\n\n* The `pricing_model` of\
                        \ the item price is `flat_fee` or `per_unit`.\n* [Multi-decimal](https://www.chargebee.com/docs/billing/2.0/site-configuration/multi-decimal-support#configuring-multi-decimal-support)\
                        \ pricing is enabled.\n* [Price overriding](https://www.chargebee.com/docs/2.0/price-override.html)\
                        \ is enabled for the site.  \n**Default value**\n\n* [`item_price.price_in_decimal`](/docs/api/item_prices/item_price-object#price_in_decimal).\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                  example: null
                item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_tiers
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The id of the item price for which the tier price is being overridden.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: "The lowest value in the quantity tier.  \n**Constraints**\n\
                        \n* Must be zero for the lowest tier.\n* For all other tiers,\
                        \ it must be equal to the `ending_unit` of the next lower\
                        \ tier.\n"
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: "The highest value in the quantity tier.  \n**Constraints**\n\
                        \n* Not applicable for the highest tier.\n* Must be equal\
                        \ to the `starting_unit` of the next higher tier.\n"
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |
                        The overridden price of the tier. The value depends on the [type of currency](/docs/api/currencies).
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: "The decimal representation of the lowest value\
                        \ of quantity in this tier.  \n**Constraints**\n\n* Must be\
                        \ zero for the lowest tier.\n* For all other tiers, it must\
                        \ be equal to the `ending_unit_in_decimal` of the next lower\
                        \ tier.  \n**Prerequisite**\n\n* [Multi-decimal](https://www.chargebee.com/docs/billing/2.0/site-configuration/multi-decimal-support#configuring-multi-decimal-support)\
                        \ pricing is enabled.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: "The decimal representation of the highest value\
                        \ of quantity in this tier.  \n**Constraints**\n\n* Not applicable\
                        \ for the highest tier.\n* Must be equal to the `starting_unit_in_decimal`\
                        \ of the next higher tier.  \n**Prerequisite**\n\n* [Multi-decimal](https://www.chargebee.com/docs/billing/2.0/site-configuration/multi-decimal-support#configuring-multi-decimal-support)\
                        \ pricing is enabled.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: "* The decimal representation of the per-unit price\
                        \ for the tier when the [item_price.pricing_model](/docs/api/item_prices/item_price-object#pricing_model)\
                        \ is `tiered` or `volume`.\n* The decimal representation of\
                        \ the total price for the item when the [item_price.pricing_model](/docs/api/item_prices/item_price-object#pricing_model)\
                        \ is `stairstep`.\n\n**Constraints**\n\n* The value must be\
                        \ in major units of the [currency](/docs/api/currencies).\
                        \  \n**Prerequisite**\n\n* [Multi-decimal](https://www.chargebee.com/docs/billing/2.0/site-configuration/multi-decimal-support#configuring-multi-decimal-support)\
                        \ pricing is enabled.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              gifter:
                style: deepObject
                explode: true
              item_tiers:
                style: deepObject
                explode: true
              subscription_items:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  hosted_page:
                    $ref: "#/components/schemas/HostedPage"
                    description: |
                      Resource object representing hosted_page
                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:
    get:
      tags:
      - hosted_pages
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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_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` - **(Deprecated)** 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_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
              - manage_payment_sources
              - collect_now
              - extend_subscription
              - 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` - **(Deprecated)** 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_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
              - manage_payment_sources
              - collect_now
              - extend_subscription
              - 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` - **(Deprecated)** 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_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
              - manage_payment_sources
              - collect_now
              - extend_subscription
              - 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_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_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` - **(Deprecated)** 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_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
              - manage_payment_sources
              - collect_now
              - extend_subscription
              - 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_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_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\] = "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/view_voucher:
    post:
      tags:
      - hosted_pages
      summary: Create a hosted page to view Boleto vouchers
      description: |
        Creates a `hosted_page`
        resource of type, `view_voucher`
        . 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.
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing hosted_page
                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:
      tags:
      - hosted_pages
      summary: Collect now
      description: "This API generates a hosted page URL to collect due payments for\
        \ the customer.\n\nOpen the hosted page in a new browser tab or window using\
        \ the `url` from this API's response. Do not embed it in your own [iframe](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/iframe).\
        \  \n**`openCheckout()` not supported**\n\nThe Chargebee.js [`openCheckout()`](https://www.chargebee.com/checkout-portal-docs/cbinstanceobj-api-ref.html#opencheckout-options)\
        \ function does not support Collect Now hosted pages. To open a Collect Now\
        \ page, open the `url` from this API's response in a new browser tab or window\
        \ (for example, `window.open(response.hosted_page.url, '_blank')`).\n"
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                brand_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [brand](/docs/api/brands) this\
                    \ hosted page should be linked to. Applicable only when multiple\
                    \ brands have been created for the site. This need not match the\
                    \ brand of the customer or subscription in the request; when the\
                    \ two differ, the value provided here is used for the hosted page.\
                    \ An alternative way of passing this parameter is by means of\
                    \ the `chargebee-brand-id` custom HTTP header; when both are provided,\
                    \ they must specify the same brand.  \n**Default behavior**\n\n\
                    * When not provided, the hosted page is linked to the brand of\
                    \ the customer or subscription in the request.\n"
                  maxLength: 50
                  example: null
                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: |
                      Resource object representing hosted_page
                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:
      tags:
      - hosted_pages
      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* 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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                brand_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [brand](/docs/api/brands) this\
                    \ hosted page should be linked to. Applicable only when multiple\
                    \ brands have been created for the site. This need not match the\
                    \ brand of the customer or subscription in the request; when the\
                    \ two differ, the value provided here is used for the hosted page.\
                    \ An alternative way of passing this parameter is by means of\
                    \ the `chargebee-brand-id` custom HTTP header; when both are provided,\
                    \ they must specify the same brand.  \n**Default behavior**\n\n\
                    * When not provided, the hosted page is linked to the brand of\
                    \ the customer or subscription in the request.\n"
                  maxLength: 50
                  example: null
                redirect_url:
                  type: string
                  deprecated: false
                  description: |
                    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.

                    **Note** :

                    * Although the customer will be redirected to the `redirect_url` 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 [`subscription_created`](/docs/api/events) or [`invoice_generated`](/docs/api/events) to verify a successful checkout.
                    * Redirect URL configured in Settings \> Hosted Pages Settings would be overriden by this redirect URL.
                    * *Eg :* *http://yoursite.com?id=\*\*\&state=succeeded*
                    * This parameter is not applicable for iframe messaging.
                  maxLength: 250
                  example: null
                layout:
                  type: string
                  deprecated: false
                  description: |
                    Specifies the UI layout for the hosted page. This overrides [the layout](https://www.chargebee.com/docs/billing/2.0/hosted-capabilities/hosted-checkout#ui-layout-options) configured in Chargebee Billing.

                    * full_page - Renders the hosted page in a full-page layout.
                    * in_app - Renders 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: |
                      Resource object representing hosted_page
                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_for_items:
    post:
      tags:
      - hosted_pages
      summary: Create checkout for a new subscription
      description: "Create a Chargebee hosted page to accept payment details from\
        \ a customer and checkout a new subscription.\nThe following steps describe\
        \ how best to use this API:\nCall this endpoint, providing [item prices](/docs/api/item_prices),\
        \ [coupons](/docs/api/coupons) and a host of other details such as billing\
        \ and shipping addresses to be prefilled for the customer on the checkout\
        \ page. You may also provide `pass_thru_content` containing information and\
        \ IDs from your systems that must be associated with the checkout page.  \n\
        **Warning**\nThe first item price in the list (parameter `subscription_items[item_price_id][0]`)\
        \ must be an `item_price` of [item_type](/docs/api/item_prices/item_price-object#item_type)\
        \ `plan`.\n\n* Send the customer to the Checkout `url` received in the response.\n\
        * Once they complete checkout, a new subscription is automatically created\
        \ and the customer is redirected to the `redirect_url` with the `id` and `state`\
        \ attributes passed as query string parameters. Although the customer will\
        \ be redirected to the `redirect_url` 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 [subscription_created](/docs/api/events)\
        \ or [invoice_generated](/docs/api/events) to verify a successful checkout.\n\
        * [Retrieve the hosted page](/docs/api/hosted_pages/retrieve-a-hosted-page)\
        \ at this stage to get the subscription and invoice details.\n\n#### Customer\
        \ resource lookup and creation\n\nWhen the [customer[id]](/docs/api/hosted_pages/create-checkout-for-a-new-subscription#customer_id)\
        \ parameter is provided and if a customer resource with the ID is found to\
        \ be already created in Chargebee, the subscription is created under that\
        \ customer resource. If not found, then a new customer resource is created\
        \ with an autogenarated ID and the subscription is created under it.\n\n#####\
        \ Multiple business entities\n\nIf multiple [business entities](/docs/api/advanced-features#mbe-header-main)\
        \ are created for the site, the customer resource lookup and creation happen\
        \ within the [context](/docs/api/business_entities#mbe-terms) of the business\
        \ entity [specified](/docs/api/advanced-features#mbe-header-main) in this\
        \ API call. If no business entity is specified, the customer resource lookup\
        \ is performed within the [site context](/docs/api/business_entities#mbe-terms),\
        \ and if not found, the resource is created for the [default business entity](/docs/api/business_entities#mbe-terms)\
        \ of the site.  \n\n### Use Cases\n\n#### Billing address editing\n\nThe `billing_address`\
        \ cannot be edited by the user during the Checkout session in either of the\
        \ following cases:\n\n* When the [`billing_address`](/docs/api/customers#billing_address)\
        \ attribute for the `customer` resource is already set.\n* You pass all mandatory\
        \ `billing_address` fields via this API.\n\nIn such cases, to allow customers\
        \ to update their billing address, use one of the following options:\n\n#####\
        \ Chargebee Hosted Pages\n\n* Integrate [Chargebee.js](https://www.chargebee.com/checkout-portal-docs/cbportal-api-ref.html)\
        \ into your website or application. Use the [`openSection()`](https://www.chargebee.com/checkout-portal-docs/cbportal-api-ref.html#opensection-options-callbacks)\
        \ function with `options.sectionType` set to `ADDRESS` to display the Customer\
        \ Portal's address section.\n* Integrate the [Customer Portal](https://www.chargebee.com/docs/billing/2.0/hosted-capabilities/portal-integration)\
        \ into your website or application. The Portal enables customers to manage\
        \ their address information.\n\n##### Customer API\n\n* Use the [Update billing\
        \ info API](/docs/api/customers/update-billing-info-for-a-customer) and provide\
        \ the appropriate `billing_address` parameters.\n"
      operationId: create_checkout_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                layout:
                  type: string
                  deprecated: false
                  description: |
                    Specifies the UI layout for the hosted page. This overrides [the layout](https://www.chargebee.com/docs/billing/2.0/hosted-capabilities/hosted-checkout#ui-layout-options) configured in Chargebee Billing.

                    * in_app - Renders the hosted page in an in-app layout.
                    * full_page - Renders the hosted page in a full-page layout.
                  enum:
                  - in_app
                  - full_page
                  example: null
                business_entity_id:
                  type: string
                  deprecated: false
                  description: "Sets the [context]() for this operation to the [business\
                    \ entity](/docs/api/advanced-features) specified. Applicable only\
                    \ when multiple business entities have been created for the site.\
                    \ When this parameter is provided, the operation is able to read/write\
                    \ data associated only to the business entity specified. When\
                    \ not provided, the operation can read/write data for the entire\
                    \ site.  \n**Note**\n\nAn alternative way of passing this parameter\
                    \ is by means of a [custom HTTP header](/docs/api/advanced-features).\
                    \  \n**See also**\n[Customer resource lookup and creation.](/docs/api/hosted_pages)\n"
                  maxLength: 50
                  example: null
                brand_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [brand](/docs/api/brands) this\
                    \ hosted page should be linked to. Applicable only when multiple\
                    \ brands have been created for the site. Resources created through\
                    \ the hosted page, such as the customer and the subscription,\
                    \ are linked to the same brand. An alternative way of passing\
                    \ this parameter is by means of the `chargebee-brand-id` custom\
                    \ HTTP header; when both are provided, they must specify the same\
                    \ brand.  \n**Default behavior**\n\n* When not provided, the brand\
                    \ of the customer or subscription referenced in the request is\
                    \ used, or the default brand defined for the site when the request\
                    \ references neither.\n"
                  maxLength: 50
                  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-item price](/docs/api/item_prices/item_price-object#billing_cycles)
                    is used.
                  minimum: 0
                  example: null
                mandatory_items_to_remove:
                  type: array
                  deprecated: false
                  description: |
                    Item ids of [mandatorily attached addons](/docs/api/attached_items)
                    that are 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](/docs/api/coupon_codes)
                    .
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                redirect_url:
                  type: string
                  deprecated: false
                  description: |
                    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.

                    **Note** :

                    * Although the customer will be redirected to the `redirect_url` 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 [`subscription_created`](/docs/api/events) or [`invoice_generated`](/docs/api/events) to verify a successful checkout.
                    * Redirect URL configured in Settings \> Hosted Pages Settings would be overriden by this redirect URL.
                    * *Eg :* *http://yoursite.com?id=\*\*\&state=succeeded*
                    * This parameter is not applicable for iframe messaging.
                  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: |
                    This attribute allows you to store custom information with the `hosted_page` 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 [redirect URL](/docs/api/hosted_pages/create-checkout-for-a-new-subscription#redirect_url)'s query parameters. Using this ID, you can fetch the hosted page and perform actions related to the success of the marketing campaign.
                  maxLength: 2048
                  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 a new subscription. If not provided, it is autogenerated.
                      maxLength: 50
                      example: null
                    trial_end:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        End of the trial period for the subscription. This overrides the trial period set for the plan-item. The value must be later than `start_date`.
                        Set it to `0`
                        to have no trial period. This parameter overrides the [`item_price_trial_period`](/docs/api/item_prices/item_price-object#trial_period)
                        directly.
                      example: null
                    start_date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        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:

                        * Backdating is enabled for subscription creation operations.
                        * 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.
                        * 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, `start_date` cannot be earlier than 14th February.
                      example: null
                    coupon:
                      type: string
                      deprecated: false
                      description: |
                        The id of the coupon. For validating the coupon code provided by the user , use the following codes in combination with the param attribute in the error response.

                        * **resource_not_found :** Returned if the coupon is not present.
                        * **resource_limit_exhausted :** Returned if the coupon has expired or the maximum redemption for the coupon has already been reached.
                        * **invalid_request :** Returned if the coupon is not applicable for the particular plan/addon.
                      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.

                        * 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
                    po_number:
                      type: string
                      deprecated: false
                      description: |
                        Purchase order number for this subscription.
                      maxLength: 100
                      example: null
                    contract_term_billing_cycle_on_renewal:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as `billing_cycles`
                        or a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)
                        .
                      maximum: 100
                      minimum: 1
                      example: null
                  example: null
                customer:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    Parameters for customer
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: "The unique identifier for the customer resource\
                        \ for which the subscription should be created.  \n**See also**\n\
                        [Customer resource lookup and creation.](/docs/api/hosted_pages)\n\
                        \n* When not provided, a new customer is created with the\
                        \ ID set to the value provided for `subscription[id]`. If\
                        \ `subscription[id]` is unavailable, then the customer ID\
                        \ is autogenerated.\n* To prevent duplicate subscriptions,\
                        \ pass `customer[id]` while generating the checkout URL. This\
                        \ enables Chargebee to validate against existing subscriptions\
                        \ for the customer. Without it, the validation is skipped.\n"
                      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: |
                        Specifies if the customer is liable for tax

                        * exempt -
                          * Customer is exempted from tax. When using Chargebee's native [Taxes](https://www.chargebee.com/docs/tax.html) feature or when using the [TaxJar integration](https://www.chargebee.com/docs/taxjar.html), no other action is needed.
                          * However, when using our [Avalara integration](https://www.chargebee.com/docs/avalara.html), optionally, specify `entity_code` or `exempt_number` attributes if you use Chargebee's [AvaTax for Sales](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption) or specify `exemption_details` attribute if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. Tax may still be applied by Avalara for certain values of `entity_code`/`exempt_number`/`exemption_details` based on the state/region/province of the taxable address.
                        * taxable -
                          Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html).
                          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.
                      enum:
                      - taxable
                      - exempt
                      - zero_rated
                      example: null
                    vat_number:
                      type: string
                      deprecated: false
                      description: |
                        The VAT/tax registration number for the customer. For customers with [billing_address](/docs/api/customers/customer-object#billing_address)

                        `country`
                        as
                        `XI`
                        (which is **United Kingdom - Northern Ireland**
                        ), the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number)
                        can be overridden by setting
                        [vat_number_prefix](/docs/api/customers/customer-object#vat_number_prefix)
                        .
                      maxLength: 20
                      example: null
                    vat_number_prefix:
                      type: string
                      deprecated: false
                      description: |
                        An overridden value for the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number).
                        Only applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)

                        `country`
                        as `XI`
                        (which is **United Kingdom - Northern Ireland**
                        ).

                        When you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)
                        in 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)
                        the Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)

                        `country`
                        as `XI`.
                        That's the code for **United Kingdom - Northern Ireland** .
                        The first two characters of the VAT number in such a case is
                        `XI`
                        by default. However, if the VAT number was registered in UK, the value should be `GB`.
                        Set
                        `vat_number_prefix`
                        to `GB`
                        for such cases.
                      maxLength: 10
                      example: null
                    is_einvoice_enabled:
                      type: boolean
                      deprecated: false
                      description: "Determines whether the customer is e-invoiced.\
                        \ When set to `true`\nor not set to any value, the customer\
                        \ is e-invoiced so long as e-invoicing is enabled for their\
                        \ country (`billing_address.country`\n). When set to `false`\n\
                        , the customer is not e-invoiced even if e-invoicing is enabled\
                        \ for their country.  \n**Tip:**\n\nIt 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.\n"
                      example: null
                    entity_identifier_scheme:
                      type: string
                      deprecated: false
                      description: "The Peppol BIS scheme associated with the [vat_number](/docs/api/customers/customer-object#vat_number)\n\
                        of the customer. This helps identify the specific type of\
                        \ customer entity. For example, `DE:VAT`\nis used for a German\
                        \ business entity while `DE:LWID45`\nis used for a German\
                        \ government entity. The value must be from the list of possible\
                        \ values and must correspond to the country provided under\
                        \ `billing_address.country`.\nSee [list of possible values](https://www.chargebee.com/docs/e-invoicing.html#supported-countries)\n\
                        .  \n**Tip:**\n\nIf there are additional entity identifiers\
                        \ for the customer not associated with the `vat_number`, they\
                        \ can be provided as the `entity_identifiers[]` array.\n"
                      maxLength: 50
                      example: null
                    entity_identifier_standard:
                      type: string
                      default: iso6523-actorid-upis
                      deprecated: false
                      description: "The standard used for specifying the `entity_identifier_scheme`.\n\
                        Currently only `iso6523-actorid-upis`\nis supported and is\
                        \ used by default when not provided.  \n**Tip:**\n\nIf there\
                        \ are additional entity identifiers for the customer not associated\
                        \ with the `vat_number`, they can be provided as the `entity_identifiers[]`\
                        \ array.\n"
                      maxLength: 50
                      example: null
                    einvoicing_method:
                      type: string
                      deprecated: false
                      description: |
                        Determines whether to send einvoice manually or automatic.

                        * manual - When manual is selected the automatic e-invoice sending is disabled. Use this value to send e-invoice manually through UI or API.
                        * automatic - Use this value to send e-invoice every time an invoice or credit note is created.
                        * site_default - The default value of the site which can be overridden at the customer level.
                      enum:
                      - automatic
                      - manual
                      - site_default
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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: |
                        Action to be taken when the contract term completes.

                        * evergreen - Contract term completes and the subscription renews.
                        * renew -
                          * Contract term completes and a new contract term is started for the number of billing cycles specified in [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).
                          * The `action_at_term_end` for the new contract term is set to `renew`.
                        * cancel - Contract term completes and subscription is canceled.
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      default: 0
                      deprecated: false
                      description: |
                        The number of days before [`contract_end`](/docs/api/contract_terms/contract_term-object#contract_end)
                        , 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.
                      example: null
                  example: null
                subscription_items:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription_items
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The unique identifier of the item price. The first item price in the list (`subscription_items[item_price_id][0]`
                        ) must be an `item_price`
                        of [item_type](/docs/api/item_prices/item_price-object#item_type)
                        `plan`
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        The quantity of the item purchased
                      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 item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        The price/per unit price of the item. When not provided, [the value set](/docs/api/item_prices/item-price-object)
                        for the item price is used. This is only applicable when the `pricing_model`
                        of the item price is `flat_fee`
                        or `per_unit`.
                        Also, it is only allowed when [price overriding](https://www.chargebee.com/docs/price-override.html)
                        is enabled for the site. The value depends on the type of currency. If `changes_scheduled_at`
                        is in the past and a `unit_price`
                        is not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](https://www.chargebee.com/docs/2.0/price-override.html)
                        is enabled for the site, the price or per-unit price of the item can be set here. The [value set for the item price](/docs/api/item_prices/item_price-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/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        For the plan-item price:
                        the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then [the value set](/docs/api/item_prices/item-price-object)
                        for the plan-item price is used.

                        For addon-item prices:
                        If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)
                        are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then [the value set under attached addons](/docs/api/attached_items/attached-item-object)
                        is used. Further, if that value is not provided, then [the value set for the addon-item price](/docs/api/item_prices/item-price-object)
                        is used.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    trial_end:
                      type: array
                      description: |
                        The date/time when the trial period of the item ends. This applies to plan-items.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    service_period_days:
                      type: array
                      description: |
                        **Not supported**:
                        This parameter is not supported in the API. If included in a request, it will be ignored.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 730
                        minimum: 1
                        example: null
                      example: null
                    charge_on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          When `charge_on_option`
                          option is set to `on_event`
                          , this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.

                          * contract_termination -
                            when a contract term is [terminated](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option)
                            .
                          * subscription_trial_start - the time when the trial period of the subscription begins.
                          * plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                          * subscription_activation -
                            the moment a subscription enters an `active`
                            or `non-renewing`
                            state. Also includes reactivations of canceled subscriptions.
                          * subscription_creation - the time of creation of the subscription.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        Indicates if the charge-item is to be charged only once or each time the `charge_on_event`
                        occurs. This parameter only applies to charge-items.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    charge_on_option:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates when the charge-item is to be charged. This parameter only applies to charge-items.

                          * on_event -
                            The item is charged at the occurrence of the event specified as `charge_on_event`
                            .
                          * immediately - The item is charged immediately on being added to the subscription.
                        enum:
                        - immediately
                        - on_event
                        example: null
                      example: null
                  required:
                  - item_price_id
                  example: null
                discounts:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for discounts
                  properties:
                    apply_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The amount on the invoice to which the discount is applied.

                          * invoice_amount -
                            The discount is applied to the invoice `sub_total`
                            .
                          * specific_item_price -
                            The discount is applied to the `invoice.line_item.amount`
                            that corresponds to the item price specified by `item_price_id`
                            .
                        enum:
                        - invoice_amount
                        - specific_item_price
                        example: null
                      example: null
                    duration_type:
                      type: array
                      items:
                        type: string
                        default: forever
                        deprecated: false
                        description: |
                          Specifies the time duration for which this discount is attached to the subscription.

                          * forever -
                            The discount is attached to the subscription and applied on the invoices till it is [explicitly removed](/docs/api/subscriptions/update-subscription-for-items#discounts_operation_type)
                            .
                          * 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 `period`
                            and `period_unit`
                            .
                          * one_time -
                            The discount stays attached to the subscription till it is applied on an invoice **once**.
                            It is removed after that from the subscription.
                        enum:
                        - one_time
                        - forever
                        - limited_period
                        example: null
                      example: null
                    percentage:
                      type: array
                      description: |
                        The percentage of the original amount that should be deducted from it.
                      items:
                        type: number
                        format: double
                        deprecated: false
                        maximum: 100
                        minimum: 0.01
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        The value of the discount. [The format of this value](/docs/api/currencies)
                        depends on the kind of currency.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    period:
                      type: array
                      description: |
                        The duration of time for which the discount is attached to the subscription, in `period_units`.
                        Applicable only when `duration_type`
                        is `limited_period`.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    period_unit:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The unit of time for `period`.
                          Applicable only when `duration_type`
                          is `limited_period`.

                          * day - A period of 24 hours.
                          * week - A period of 7 days.
                          * month - A period of 1 calendar month.
                          * year - A period of 1 calendar year.
                        enum:
                        - day
                        - week
                        - month
                        - year
                        example: null
                      example: null
                    included_in_mrr:
                      type: array
                      description: |
                        The discount is included in MRR calculations for your site. This attribute is only applicable when `duration_type`
                        is `one_time`
                        and when the [feature is enabled](https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation)
                        in Chargebee. Also, If the [site-level setting](https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation)
                        is to exclude one-time discounts from MRR calculations, this value is always returned `false`.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    item_price_id:
                      type: array
                      description: |
                        The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                        in the subscription to which the discount is to be applied. Relevant only when `apply_on`
                        = `specific_item_price`.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Specifies the number of free units provided for the item, without affecting the total quantity sold
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                  required:
                  - duration_type
                  example: null
                item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_tiers
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The id of the item price for which the tier price is being overridden.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: |
                        The lowest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The highest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |
                        The overridden price of the tier. The value depends on the [type of currency](/docs/api/hosted_pages)
                        .
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    pricing_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Pricing type for the tier.

                          * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                          * flat_fee -
                            Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                            pricing model, `pricing_type`
                            will be set to `flat_fee`
                            by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                          * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                        enum:
                        - per_unit
                        - flat_fee
                        - package
                        example: null
                      example: null
                    package_size:
                      type: array
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                  example: null
                entity_identifiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for entity_identifiers
                  properties:
                    id:
                      type: array
                      description: |
                        The unique id for the `entity_identifier[i]`
                        in Chargebee. This is required when `entity_identifier[operation][i]`
                        is `update`
                        or `delete`
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    scheme:
                      type: array
                      description: "The Peppol BIS scheme associated with the [vat_number](/docs/api/customers/customer-object#vat_number)\n\
                        of the customer. This helps identify the specific type of\
                        \ customer entity. For example, `DE:VAT`\nis used for a German\
                        \ business entity while `DE:LWID45`\nis used for a German\
                        \ government entity. The value must be from the list of possible\
                        \ values and must correspond to the country provided under\
                        \ `billing_address.country`.\nSee [list of possible values](https://www.chargebee.com/docs/e-invoicing.html#supported-countries)\n\
                        .  \n**Tip:**\n\nIf there is only one entity identifier for\
                        \ the customer and the value is the same as `vat_number`,\
                        \ then there is no need to provide the `entity_identifiers[]`\
                        \ array. See [description for `entity_identifiers[]`](/docs/api/customers/customer-object#entity_identifiers).\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    value:
                      type: array
                      description: "The value of the `entity_identifier`.\nThis identifies\
                        \ the customer entity on the Peppol network. For example:\
                        \ `10101010-STO-10`\n.  \n**Tip:**\n\nIf there is only one\
                        \ entity identifier for the customer and the value is the\
                        \ same as `vat_number`, then there is no need to provide the\
                        \ `entity_identifiers[]` array. See [description for `entity_identifiers[]`](/docs/api/customers/customer-object#entity_identifiers).\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    operation:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The operation to be performed for the `entity_identifier`
                          .

                          * create -
                            Creates a new `entity_identifier`
                            for the customer.
                          * update -
                            Updates an existing `entity_identifier`
                            for the customer. `entity_identifier[id]`
                            must be provided in this case.
                          * delete -
                            Deletes an existing `entity_identifier`
                            for the customer. `entity_identifier[id]`
                            must be provided in this case.
                        enum:
                        - create
                        - update
                        - delete
                        example: null
                      example: null
                    standard:
                      type: array
                      description: "The standard used for specifying the `entity_identifier`\n\
                        `scheme`.\nCurrently, only `iso6523-actorid-upis`\nis supported\
                        \ and is used by default when not provided.  \n**Tip:**\n\n\
                        If there is only one entity identifier for the customer and\
                        \ the value is the same as `vat_number`, then there is no\
                        \ need to provide the `entity_identifiers[]` array. See [description\
                        \ for `entity_identifiers[]`](/docs/api/customers/customer-object#entity_identifiers).\n"
                      items:
                        type: string
                        default: iso6523-actorid-upis
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              billing_address:
                style: deepObject
                explode: true
              card:
                style: deepObject
                explode: true
              contract_term:
                style: deepObject
                explode: true
              customer:
                style: deepObject
                explode: true
              discounts:
                style: deepObject
                explode: true
              entity_identifiers:
                style: deepObject
                explode: true
              item_tiers:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              subscription:
                style: deepObject
                explode: true
              subscription_items:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  hosted_page:
                    $ref: "#/components/schemas/HostedPage"
                    description: |
                      Resource object representing hosted_page
                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:
      tags:
      - hosted_pages
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                brand_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [brand](/docs/api/brands) this\
                    \ hosted page should be linked to. Applicable only when multiple\
                    \ brands have been created for the site. This need not match the\
                    \ brand of the customer or subscription in the request; when the\
                    \ two differ, the value provided here is used for the hosted page.\
                    \ An alternative way of passing this parameter is by means of\
                    \ the `chargebee-brand-id` custom HTTP header; when both are provided,\
                    \ they must specify the same brand.  \n**Default behavior**\n\n\
                    * When not provided, the hosted page is linked to the brand of\
                    \ the customer or subscription in the request.\n"
                  maxLength: 50
                  example: null
                redirect_url:
                  type: string
                  deprecated: false
                  description: |
                    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.

                    **Note** :

                    * Although the customer will be redirected to the `redirect_url` 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 [`subscription_created`](/docs/api/events) or [`invoice_generated`](/docs/api/events) to verify a successful checkout.
                    * Redirect URL configured in Settings \> Hosted Pages Settings would be overriden by this redirect URL.
                    * *Eg :* *http://yoursite.com?id=\*\*\&state=succeeded*
                    * This parameter is not applicable for iframe messaging.
                  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: |
                      Resource object representing hosted_page
                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_for_items:
    post:
      tags:
      - hosted_pages
      summary: Create checkout to update a subscription
      description: "Create a Chargebee hosted page to accept payment details from\
        \ a customer and checkout to update the subscription.\n\nThe following steps\
        \ describe how best to use this API:\n\nProvide [item prices](/docs/api/item_prices),\
        \ [coupons](/docs/api/coupons) and a host of other details such as billing\
        \ and shipping addresses to be prefilled for the customer on the checkout\
        \ page. You may also provide `pass_thru_content` containing information and\
        \ IDs from your systems that must be associated with the checkout page.  \n\
        **Warning**\nThe first item price in the list (parameter `subscription_items[item_price_id][0]`)\
        \ must be an `item_price` of [item_type](/docs/api/item_prices/item_price-object#item_type)\
        \ `plan`.\n\n* Send the customer to the Checkout `url` received in the response.\
        \ They can now add a payment method or use an existing one, to complete the\
        \ checkout.\n\n* The subscription is updated and the customer is redirected\
        \ to the `redirect_url` with the `id` and `state` attributes passed as query\
        \ string parameters.\n\n  Although the customer will be redirected to the\
        \ `redirect_url` 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 [subscription_created](/docs/api/events)\
        \ or [invoice_generated](/docs/api/events) to verify a successful checkout.\n\
        \n* [Retrieve the hosted page](/docs/api/hosted_pages/retrieve-a-hosted-page)\
        \ at this stage to get the subscription and invoice details.\n\n### Impacts\n\
        \n**#### Subscription and Ramps: Impact on existing scheduled changes**  \n\
        * If the subscription has existing scheduled changes, the behavior depends\
        \ on whether [Ramps](/docs/api/ramps) are enabled:\n  * **Ramps disabled**:\
        \ Any existing scheduled change on the subscription is deleted.\n  * **Ramps\
        \ enabled with compatibility mode** :\n    * If only one ramp is present:\n\
        \      * If the ramp was created using this API, the ramp is deleted.\n  \
        \    * If the ramp was created using the [Create a ramp API](/docs/api/ramps/create-a-ramp),\
        \ and the date-time of the new change is before the date-time of the ramp,\
        \ then the ramp is moved to `draft` status if the [auto-draft conditions](/docs/api/ramps/ramp-object#auto-draft)\
        \ are met.\n    * If multiple ramps are present: all ramps after the date-time\
        \ of the new change are moved to `draft` status if the [auto-draft conditions](/docs/api/ramps/ramp-object#auto-draft)\
        \ are met.\n* For more details, see [Ramps API compatibility mode](/docs/api/subscriptions#ramps-compat-mode).\
        \  \n\n### Use Cases\n\n#### Edit billing address\n\nIf the [`billing_address`](/docs/api/customers#billing_address)\
        \ attribute for the `customer` resource is already set, then the `billing_address`\
        \ cannot be edited by the user during the Checkout session. To allow customers\
        \ to update their billing address, use one of the following options:\n\n#####\
        \ Chargebee Hosted Pages\n\n* Integrate [Chargebee.js](https://www.chargebee.com/checkout-portal-docs/cbportal-api-ref.html)\
        \ into your website or application. Use the [`openSection()`](https://www.chargebee.com/checkout-portal-docs/cbportal-api-ref.html#opensection-options-callbacks)\
        \ function with `options.sectionType` set to `ADDRESS` to display the Customer\
        \ Portal's address section.\n* Integrate the [Customer Portal](https://www.chargebee.com/docs/billing/2.0/hosted-capabilities/portal-integration)\
        \ into your website or application. The Portal enables customers to manage\
        \ their address information.\n\n##### Customer API\n\n* Use the [Update billing\
        \ info API](/docs/api/customers/update-billing-info-for-a-customer) and provide\
        \ the appropriate `billing_address` parameters.\n"
      operationId: create_checkout_to_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                layout:
                  type: string
                  deprecated: false
                  description: |
                    Specifies the UI layout for the hosted page. This overrides [the layout](https://www.chargebee.com/docs/billing/2.0/hosted-capabilities/hosted-checkout#ui-layout-options) configured in Chargebee Billing.

                    * in_app - Renders the hosted page in an in-app layout.
                    * full_page - Renders the hosted page in a full-page layout.
                  enum:
                  - in_app
                  - full_page
                  example: null
                brand_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [brand](/docs/api/brands) this\
                    \ hosted page should be linked to. Applicable only when multiple\
                    \ brands have been created for the site. This need not match the\
                    \ brand of the customer or subscription in the request; when the\
                    \ two differ, the value provided here is used for the hosted page.\
                    \ An alternative way of passing this parameter is by means of\
                    \ the `chargebee-brand-id` custom HTTP header; when both are provided,\
                    \ they must specify the same brand.  \n**Default behavior**\n\n\
                    * When not provided, the hosted page is linked to the brand of\
                    \ the customer or subscription in the request.\n"
                  maxLength: 50
                  example: null
                mandatory_items_to_remove:
                  type: array
                  deprecated: false
                  description: |
                    Item ids of [mandatorily attached addons](/docs/api/attached_items)
                    that are to be removed from the subscription.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                replace_items_list:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    If `true`
                    then the existing `subscription_items`
                    list for the subscription is replaced by the one provided. If `false`
                    then the provided `subscription_items`
                    list gets added to the existing list.
                  example: null
                invoice_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    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 `create_pending_invoices`
                    is set to `true`
                    , 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 `invoice_date`.
                    When passing this parameter, the following prerequisites must be met:

                    * `invoice_date` must be in the past.
                    * `invoice_date` 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.
                    * It is not earlier than `changes_scheduled_at`, `reactivate_from`, or `trial_end`.
                    * `invoice_immediately` is `true`. .
                  example: null
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Billing cycles set for plan-item price is used by default.
                  minimum: 0
                  example: null
                terms_to_charge:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of subscription billing cycles to [invoice in advance](https://www.chargebee.com/docs/advance-invoices.html).
                    If a new term is started for the subscription due to this API call, then `terms_to_charge`
                    is inclusive of this new term. See description for the `force_term_reset`
                    parameter to learn more about when a subscription term is reset.
                  minimum: 1
                  example: null
                reactivate_from:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    If the subscription `status`
                    is `cancelled`
                    and it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.
                    **Note:**
                    It is recommended not to pass this parameter along with `changed_scheduled_at`.
                    `reactivate_from`
                    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:

                    * Backdating must be enabled for subscription reactivation operations.
                    * 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.
                    * The date is on or after the last date/time any of the product catalog items of the subscription were changed.
                    * 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, `changes_scheduled_at` cannot be earlier than 14th February. .
                  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: |
                    If `true`
                    then the existing `coupon_ids`
                    list for the subscription is replaced by the one provided. If `false`
                    then the provided `coupon_ids`
                    list gets added to the existing list.
                  example: null
                reactivate:
                  type: boolean
                  deprecated: false
                  description: |
                    This parameter is only relevant for `cancelled`
                    subscriptions. When set to `true`
                    , it activates the canceled subscription; otherwise, subscription changes are applied without altering its `status`.
                    Additionally, if not explicitly set and the `subscription_items`
                    provided in the API differ from the existing items, the subscription will still be reactivated.
                  example: null
                force_term_reset:
                  type: boolean
                  default: false
                  deprecated: false
                  description: "**Note** : This parameter is relevant only for subscriptions\
                    \ with `status` of `active`, `non_renewing`, or `cancelled`.\n\
                    \nWhen you set this parameter to `true`, the subscription term\
                    \ resets to the date of the subscription change.\nBy default,\
                    \ if you change the plan-item price 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.  \n**Note**\
                    \ : If the new plan-item price has a different billing period\
                    \ from the current plan-item price, the subscription term resets\
                    \ automatically, regardless of the value of `force_term_reset`.\
                    \  \n**Constraints**\nIf you pass `force_term_reset`, you must\
                    \ also pass `invoice_usages` with the same value when **all**\
                    \ of the following site configuration settings are enabled:\n\n\
                    * [Usage-based billing](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/setting-up-usage-based-billing)\n\
                    * Mid-term changes for usage-based items\n* [Invoice and charge\
                    \ for usage-based items when a subscription is changing](https://www.chargebee.com/docs/billing/2.0/subscriptions/metered_billing#configuring-metered-billing)\n"
                  example: null
                change_option:
                  type: string
                  deprecated: false
                  description: "Specifies when the subscription change takes effect.\
                    \  \n**See also**\n\n* [Impacts on existing scheduled changes](/docs/api/subscriptions/update-subscription-for-items#impact-scheduled-changes).\n\
                    \n* end_of_term -\n  **Deprecated**\n\n  This option is deprecated;\
                    \ use the [Create a ramp API](/docs/api/ramps/create-a-ramp) instead.\n\
                    \n  The change is carried out at the end of the current billing\
                    \ cycle of the subscription.\n* specific_date -\n  **Deprecated\
                    \ for scheduling changes**\n\n  This option is deprecated for\
                    \ scheduling changes to occur at a future date-time, use the [Create\
                    \ a ramp API](/docs/api/ramps/create-a-ramp) instead.\n\n  Executes\
                    \ the change on a specified date. The change occurs as of the\
                    \ date-time defined in `changes_scheduled_at`.\n* immediately\
                    \ - The subscription change takes effect immediately.\n"
                  enum:
                  - immediately
                  - end_of_term
                  - specific_date
                  example: null
                changes_scheduled_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: "The date-time at which the subscription change is\
                    \ to happen or has happened.  \n**Required if**\n\n* `change_option`\
                    \ is set to `specific_date`.  \n**Deprecated for scheduling changes**\n\
                    \n* Setting this parameter to a future date-time for scheduling\
                    \ changes is deprecated. Use the [Create a ramp API](/docs/api/ramps/create-a-ramp)\
                    \ instead.  \n**Constraints**\n\n* Do not pass this parameter\
                    \ along with `reactivate_from`.  \n**Backdated changes**\n\n`changes_scheduled_at`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:\n\n* Backdating must be [enabled](https://www.chargebee.com/docs/billing/2.0/subscriptions/backdating#configuring-backdated-subscription-actions-and-invoicing)\
                    \ for subscription change operations.\n* Only the following changes\
                    \ can be backdated:\n  * Changes in the recurring items or their\
                    \ prices.\n  * Addition of non-recurring items.\n* Subscription\
                    \ `status` is `active`, `cancelled`, or `non_renewing`.\n* 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.\n* The date is on or after `current_term_start`.\n\
                    * The date is on or after the last date/time any of the following\
                    \ changes were made:\n  * Changes in the recurring items or their\
                    \ prices.\n  * Addition of non-recurring items.\n"
                  example: null
                invoice_usages:
                  type: boolean
                  default: false
                  deprecated: false
                  description: "Setting this attribute to `true` will invoice the\
                    \ overages for the metered items during the subscription change.\
                    \  \n**Constraints**\nIf you pass `invoice_usages`, you must also\
                    \ pass `force_term_reset` with the same value when **all** of\
                    \ the following site configuration settings are enabled:\n\n*\
                    \ [Usage-based billing](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/setting-up-usage-based-billing)\n\
                    * Mid-term changes for usage-based items\n* [Invoice and charge\
                    \ for usage-based items when a subscription is changing](https://www.chargebee.com/docs/billing/2.0/subscriptions/metered_billing#configuring-metered-billing)\n"
                  example: null
                redirect_url:
                  type: string
                  deprecated: false
                  description: |
                    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.

                    **Note** :

                    * Although the customer will be redirected to the `redirect_url` 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 [`subscription_created`](/docs/api/events) or [`invoice_generated`](/docs/api/events) to verify a successful checkout.
                    * Redirect URL configured in Settings \> Hosted Pages Settings would be overriden by this redirect URL.
                    * *Eg :* *http://yoursite.com?id=\*\*\&state=succeeded*
                    * This parameter is not applicable for iframe messaging.
                  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: |
                    This attribute allows you to store custom information with the `hosted_page` 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 [redirect URL](/docs/api/hosted_pages/create-checkout-to-update-a-subscription#redirect_url)'s query parameters. Using this ID, you can fetch the hosted page and perform actions related to the success of the marketing campaign.
                  maxLength: 2048
                  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
                    start_date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The new start date of a `future`
                        subscription. Applicable only for `future`
                        subscriptions.
                      example: null
                    trial_end:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The time at which the trial has ended or will end for the subscription. This is only allowed when the subscription `status`
                        is `future`
                        , `in_trial`
                        , or `cancelled`.
                        Also, the value must not be earlier than `changes_scheduled_at`
                        or `start_date`.
                        **Note** :
                        This parameter can be backdated (set to a value in the past) only when the subscription is in `cancelled`
                        or `in_trial`
                        `status`.
                        Do this to keep a record of when the trial ended in case it ended at some point in the past. When `trial_end`
                        is backdated, the subscription immediately goes into `active`
                        or `non_renewing`
                        status. This parameter overrides the [`item_price_trial_period`](/docs/api/item_prices/item_price-object#trial_period)
                        directly.
                      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
                    contract_term_billing_cycle_on_renewal:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as `billing_cycles`
                        or a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)
                        .
                      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: |
                        The VAT/tax registration number for the customer. For customers with [billing_address](/docs/api/customers/customer-object#billing_address)

                        `country`
                        as
                        `XI`
                        (which is **United Kingdom - Northern Ireland**
                        ), the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number)
                        can be overridden by setting
                        [vat_number_prefix](/docs/api/customers/customer-object#vat_number_prefix)
                        .
                      maxLength: 20
                      example: null
                    vat_number_prefix:
                      type: string
                      deprecated: false
                      description: |
                        An overridden value for the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number).
                        Only applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)

                        `country`
                        as `XI`
                        (which is **United Kingdom - Northern Ireland**
                        ).

                        When you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)
                        in 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)
                        the Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)

                        `country`
                        as `XI`.
                        That's the code for **United Kingdom - Northern Ireland** .
                        The first two characters of the VAT number in such a case is
                        `XI`
                        by default. However, if the VAT number was registered in UK, the value should be `GB`.
                        Set
                        `vat_number_prefix`
                        to `GB`
                        for such cases.
                      maxLength: 10
                      example: null
                    is_einvoice_enabled:
                      type: boolean
                      deprecated: false
                      description: "Determines whether the customer is e-invoiced.\
                        \ When set to `true`\nor not set to any value, the customer\
                        \ is e-invoiced so long as e-invoicing is enabled for their\
                        \ country (`billing_address.country`\n). When set to `false`\n\
                        , the customer is not e-invoiced even if e-invoicing is enabled\
                        \ for their country.  \n**Tip:**\n\nIt 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.\n"
                      example: null
                    entity_identifier_scheme:
                      type: string
                      deprecated: false
                      description: "The Peppol BIS scheme associated with the [vat_number](/docs/api/customers/customer-object#vat_number)\n\
                        of the customer. This helps identify the specific type of\
                        \ customer entity. For example, `DE:VAT`\nis used for a German\
                        \ business entity while `DE:LWID45`\nis used for a German\
                        \ government entity. The value must be from the list of possible\
                        \ values and must correspond to the country provided under\
                        \ `billing_address.country`.\nSee [list of possible values](https://www.chargebee.com/docs/e-invoicing.html#supported-countries)\n\
                        .  \n**Tip:**\n\nIf there are additional entity identifiers\
                        \ for the customer not associated with the `vat_number`, they\
                        \ can be provided as the `entity_identifiers[]` array.\n"
                      maxLength: 50
                      example: null
                    entity_identifier_standard:
                      type: string
                      default: iso6523-actorid-upis
                      deprecated: false
                      description: "The standard used for specifying the `entity_identifier_scheme`.\n\
                        Currently only `iso6523-actorid-upis`\nis supported and is\
                        \ used by default when not provided.  \n**Tip:**\n\nIf there\
                        \ are additional entity identifiers for the customer not associated\
                        \ with the `vat_number`, they can be provided as the `entity_identifiers[]`\
                        \ array.\n"
                      maxLength: 50
                      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: |
                        Action to be taken when the contract term completes.

                        * evergreen - Contract term completes and the subscription renews.
                        * renew -
                          * Contract term completes and a new contract term is started for the number of billing cycles specified in [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).
                          * The `action_at_term_end` for the new contract term is set to `renew`.
                        * cancel - Contract term completes and subscription is canceled.
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      default: 0
                      deprecated: false
                      description: |
                        The number of days before [`contract_end`](/docs/api/contract_terms/contract_term-object#contract_end)
                        , 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.
                      example: null
                  example: null
                subscription_items:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription_items
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The unique identifier of the item price. The first item price in the list (`subscription_items[item_price_id][0]`
                        ) must be an `item_price`
                        of [item_type](/docs/api/item_prices/item_price-object#item_type)
                        `plan`
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        The quantity of the item purchased
                      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 item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        The price/per unit price of the item. When not provided, [the value set](/docs/api/item_prices/item-price-object)
                        for the item price is used. This is only applicable when the `pricing_model`
                        of the item price is `flat_fee`
                        or `per_unit`.
                        Also, it is only allowed when [price overriding](https://www.chargebee.com/docs/price-override.html)
                        is enabled for the site. The value depends on the type of currency. If `changes_scheduled_at`
                        is in the past and a `unit_price`
                        is not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](https://www.chargebee.com/docs/price-override.html)
                        is enabled for the site, the price or per-unit price of the item can be set here. The [value set for the item price](/docs/api/item_prices/item_price-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/getting-started)
                        is enabled. If `changes_scheduled_at`
                        is in the past and a `unit_price_in_decimal`
                        is not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        For the plan-item price:
                        the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then [the value set](/docs/api/item_prices/item-price-object)
                        for the plan-item price is used.

                        For addon-item prices:
                        If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)
                        are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then [the value set under attached addons](/docs/api/attached_items/attached-item-object)
                        is used. Further, if that value is not provided, then [the value set for the addon-item price](/docs/api/item_prices/item-price-object)
                        is used.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    trial_end:
                      type: array
                      description: |
                        The date/time when the trial period of the item ends. This applies to plan-items.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    service_period_days:
                      type: array
                      description: |
                        **Not supported**:
                        This parameter is not supported in the API. If included in a request, it will be ignored.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 730
                        minimum: 1
                        example: null
                      example: null
                    charge_on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          When `charge_on_option`
                          option is set to `on_event`
                          , this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.

                          * contract_termination -
                            when a contract term is [terminated](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option)
                            .
                          * subscription_trial_start - the time when the trial period of the subscription begins.
                          * plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                          * subscription_activation -
                            the moment a subscription enters an `active`
                            or `non-renewing`
                            state. Also includes reactivations of canceled subscriptions.
                          * subscription_creation - the time of creation of the subscription.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        Indicates if the charge-item is to be charged only once or each time the `charge_on_event`
                        occurs. This parameter only applies to charge-items.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    charge_on_option:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates when the charge-item is to be charged. This parameter only applies to charge-items.

                          * on_event -
                            The item is charged at the occurrence of the event specified as `charge_on_event`
                            .
                          * immediately - The item is charged immediately on being added to the subscription.
                        enum:
                        - immediately
                        - on_event
                        example: null
                      example: null
                  required:
                  - item_price_id
                  example: null
                discounts:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for discounts
                  properties:
                    apply_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The amount on the invoice to which the discount is applied.

                          * invoice_amount -
                            The discount is applied to the invoice `sub_total`
                            .
                          * specific_item_price -
                            The discount is applied to the `invoice.line_item.amount`
                            that corresponds to the item price specified by `item_price_id`
                            .
                        enum:
                        - invoice_amount
                        - specific_item_price
                        example: null
                      example: null
                    duration_type:
                      type: array
                      items:
                        type: string
                        default: forever
                        deprecated: false
                        description: |
                          Specifies the time duration for which this discount is attached to the subscription.

                          * forever -
                            The discount is attached to the subscription and applied on the invoices till it is [explicitly removed](/docs/api/subscriptions/update-subscription-for-items#discounts_operation_type)
                            .
                          * 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 `period`
                            and `period_unit`
                            .
                          * one_time -
                            The discount stays attached to the subscription till it is applied on an invoice **once**.
                            It is removed after that from the subscription.
                        enum:
                        - one_time
                        - forever
                        - limited_period
                        example: null
                      example: null
                    percentage:
                      type: array
                      description: |
                        The percentage of the original amount that should be deducted from it.
                      items:
                        type: number
                        format: double
                        deprecated: false
                        maximum: 100
                        minimum: 0.01
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        The value of the discount. [The format of this value](/docs/api/currencies)
                        depends on the kind of currency.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    period:
                      type: array
                      description: |
                        The duration of time for which the discount is attached to the subscription, in `period_units`.
                        Applicable only when `duration_type`
                        is `limited_period`.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    period_unit:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The unit of time for `period`.
                          Applicable only when `duration_type`
                          is `limited_period`.

                          * day - A period of 24 hours.
                          * week - A period of 7 days.
                          * month - A period of 1 calendar month.
                          * year - A period of 1 calendar year.
                        enum:
                        - day
                        - week
                        - month
                        - year
                        example: null
                      example: null
                    included_in_mrr:
                      type: array
                      description: |
                        The discount is included in MRR calculations for your site. This attribute is only applicable when `duration_type`
                        is `one_time`
                        and when the [feature is enabled](https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation)
                        in Chargebee. Also, If the [site-level setting](https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation)
                        is to exclude one-time discounts from MRR calculations, this value is always returned `false`.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    item_price_id:
                      type: array
                      description: |
                        The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                        in the subscription to which the discount is to be applied. Relevant only when `apply_on`
                        = `specific_item_price`.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Specifies the number of free units provided for the item, without affecting the total quantity sold
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    operation_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The operation to be carried out for the discount.

                          * add - The discount is attached to the subscription.
                          * remove -
                            The discount (given by `discounts[id]`
                            ) is removed from the subscription. Subsequent invoices will no longer have the discount applied. **Tip:**
                            If you want to replace a discount, `remove`
                            it and `add`
                            another in the same API call.
                        enum:
                        - add
                        - remove
                        example: null
                      example: null
                    id:
                      type: array
                      description: |
                        An immutable unique id for the discount. It is always auto-generated.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  required:
                  - duration_type
                  - operation_type
                  example: null
                item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_tiers
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The id of the item price for which the tier price is being overridden.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: |
                        The lowest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The highest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |
                        The overridden price of the tier. The value depends on the [type of currency](/docs/api/hosted_pages)
                        .
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    pricing_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Pricing type for the tier.

                          * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                          * flat_fee -
                            Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                            pricing model, `pricing_type`
                            will be set to `flat_fee`
                            by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                          * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                        enum:
                        - per_unit
                        - flat_fee
                        - package
                        example: null
                      example: null
                    package_size:
                      type: array
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                  example: null
                entity_identifiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for entity_identifiers
                  properties:
                    id:
                      type: array
                      description: |
                        The unique id for the `entity_identifier[i]`
                        in Chargebee. This is required when `entity_identifier[operation][i]`
                        is `update`
                        or `delete`
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 40
                        example: null
                      example: null
                    scheme:
                      type: array
                      description: "The Peppol BIS scheme associated with the [vat_number](/docs/api/customers/customer-object#vat_number)\n\
                        of the customer. This helps identify the specific type of\
                        \ customer entity. For example, `DE:VAT`\nis used for a German\
                        \ business entity while `DE:LWID45`\nis used for a German\
                        \ government entity. The value must be from the list of possible\
                        \ values and must correspond to the country provided under\
                        \ `billing_address.country`.\nSee [list of possible values](https://www.chargebee.com/docs/e-invoicing.html#supported-countries)\n\
                        .  \n**Tip:**\n\nIf there is only one entity identifier for\
                        \ the customer and the value is the same as `vat_number`,\
                        \ then there is no need to provide the `entity_identifiers[]`\
                        \ array. See [description for `entity_identifiers[]`](/docs/api/customers/customer-object#entity_identifiers).\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    value:
                      type: array
                      description: "The value of the `entity_identifier`.\nThis identifies\
                        \ the customer entity on the Peppol network. For example:\
                        \ `10101010-STO-10`\n.  \n**Tip:**\n\nIf there is only one\
                        \ entity identifier for the customer and the value is the\
                        \ same as `vat_number`, then there is no need to provide the\
                        \ `entity_identifiers[]` array. See [description for `entity_identifiers[]`](/docs/api/customers/customer-object#entity_identifiers).\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    operation:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The operation to be performed for the `entity_identifier`
                          .

                          * create -
                            Creates a new `entity_identifier`
                            for the customer.
                          * update -
                            Updates an existing `entity_identifier`
                            for the customer. `entity_identifier[id]`
                            must be provided in this case.
                          * delete -
                            Deletes an existing `entity_identifier`
                            for the customer. `entity_identifier[id]`
                            must be provided in this case.
                        enum:
                        - create
                        - update
                        - delete
                        example: null
                      example: null
                    standard:
                      type: array
                      description: "The standard used for specifying the `entity_identifier`\n\
                        `scheme`.\nCurrently, only `iso6523-actorid-upis`\nis supported\
                        \ and is used by default when not provided.  \n**Tip:**\n\n\
                        If there is only one entity identifier for the customer and\
                        \ the value is the same as `vat_number`, then there is no\
                        \ need to provide the `entity_identifiers[]` array. See [description\
                        \ for `entity_identifiers[]`](/docs/api/customers/customer-object#entity_identifiers).\n"
                      items:
                        type: string
                        default: iso6523-actorid-upis
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              card:
                style: deepObject
                explode: true
              contract_term:
                style: deepObject
                explode: true
              customer:
                style: deepObject
                explode: true
              discounts:
                style: deepObject
                explode: true
              entity_identifiers:
                style: deepObject
                explode: true
              item_tiers:
                style: deepObject
                explode: true
              subscription:
                style: deepObject
                explode: true
              subscription_items:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  hosted_page:
                    $ref: "#/components/schemas/HostedPage"
                    description: |
                      Resource object representing hosted_page
                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:
      tags:
      - hosted_pages
      summary: Create a pre-cancel hosted page
      description: |
        Creates a `hosted_page`
        resource of `type`
        `pre_cancel`
        . 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 [configured in the Chargebee Growth app](https://www.chargebee.com/docs/growth/experiences/setting-up-cancel-pages)
        , along with the data provided as input to this endpoint. Call the endpoint before your customer clicks the **Cancel**
        button, and when they do, route them to the [url](/docs/api/hosted_pages/hosted_page-object#url)
        in the endpoint response.
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                brand_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [brand](/docs/api/brands) this\
                    \ hosted page should be linked to. Applicable only when multiple\
                    \ brands have been created for the site. This need not match the\
                    \ brand of the customer or subscription in the request; when the\
                    \ two differ, the value provided here is used for the hosted page.\
                    \ An alternative way of passing this parameter is by means of\
                    \ the `chargebee-brand-id` custom HTTP header; when both are provided,\
                    \ they must specify the same brand.  \n**Default behavior**\n\n\
                    * When not provided, the hosted page is linked to the brand of\
                    \ the customer or subscription in the request.\n"
                  maxLength: 50
                  example: null
                pass_thru_content:
                  type: string
                  deprecated: false
                  description: |
                    Additional data to be passed to Chargebee Growth. Only the value of `pass_thru_content.custom` is sent to Chargebee Growth. It is sent as the value of the [`custom`](https://www.chargebee.com/checkout-portal-docs/cancel-page-api-ref.html#parameters) property. The fields provided in `pass_thru_content.custom` must be preconfigured in Chargebee Growth.

                    Although only `pass_thru_content.custom` is sent to Chargebee Growth, all of `pass_thru_content` is stored by Chargebee Billing and is retrievable as an [attribute](/docs/api/hosted_pages/hosted_page-object#pass_thru_content) of the `hosted_page`.
                    .
                  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
                locale:
                  type: string
                  deprecated: false
                  maxLength: 50
                  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: |
                      Resource object representing hosted_page
                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:
      tags:
      - hosted_pages
      summary: Acknowledge a hosted page
      description: |
        When a hosted page is successfully completed by the user and processed by Chargebee, its [`state`](/docs/api/hosted_pages/hosted_page-object#state)
        is automatically changed to `succeeded`
        . 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 `succeeded`
        state and change its state to `acknowledged`
        .

        **Note:**
        The hosted page status must be succeeded for this API call to be allowed.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing hosted_page
                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:
      tags:
      - hosted_pages
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing hosted_page
                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:
      tags:
      - hosted_pages
      summary: Retrieve a hosted page
      description: "When you retrieve a hosted page whose `status` is `successful`,\
        \ the `content` attribute has the following objects based on the `type` of\
        \ the hosted page.  \n\n|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n\
        | **`type` of hosted page** | **`content` attribute constituents**       \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                         |\n| `checkout_new`            | * `customer`: the\
        \ object representing the details of the [Customer](/docs/api/customers/customer-object)\
        \ for whom the subscription was created. * `subscription`: the new Subscription\
        \ object created. * `card`: the [Card](/docs/api/cards/card-object) object\
        \ if the [payment method](/docs/api/customers/customer-object#payment_method)\
        \ `type` used was `card`. * `invoice`: the Invoice object, if an invoice was\
        \ generated.                                                             \
        \                                                                        \
        \                      |\n| `checkout_existing`       | * `customer`: the\
        \ object representing the details of the [Customer](/docs/api/customers/customer-object)\
        \ whose subscription was changed. * `subscription`: the updated Subscription\
        \ object created. * `card`: the [Card](/docs/api/cards/card-object) object\
        \ if the [payment method](/docs/api/customers/customer-object#payment_method)\
        \ `type` used was `card`. * `invoice`: the Invoice object, if an invoice was\
        \ generated for the subscription change.                                 \
        \                                                                        \
        \                         |\n| `update_payment_method`   | * `customer`: the\
        \ object representing the details of the [Customer](/docs/api/customers/customer-object)\
        \ whose subscription was changed. * `card`: the [Card](/docs/api/cards/card-object)\
        \ object if the new [payment method](/docs/api/customers/customer-object#payment_method)\
        \ added was of `type` `card`.                                            \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \           |\n| `pre_cancel`              | `retention`: Use the `bypass`\
        \ flag in this object to route the cancellation flow to the merchants' portal\
        \ or the Chargebee Retention.- If `bypass` flag is `true`, you should route\
        \ the end-customers to your native cancellation flow. * If the `bypass` flag\
        \ is `false`, you should route the end-customers to the hosted page URL. **Note:**\
        \ Retention is currently in `beta`. To enable Retention, [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)\
        \ |\n| `collect_now`             | * `transactions`: this object should contain\
        \ a list of [transactions](/docs/api/transactions/transaction-object) triggered\
        \ from the `collect_now` hosted page. Each transaction in the list should\
        \ be represented as an array that includes relevant information about the\
        \ transaction, such as transaction ID, customer ID, amount, currency, payment\
        \ method, and any other relevant details. * `customer`: this object should\
        \ contain the customer record associated with the transaction. The key, `customer_id`\
        \ is used to link the transaction to the corresponding customer record.  \
        \ |\n\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing hosted_page
                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:
      tags:
      - hosted_pages
      summary: Manage payment sources
      description: |
        This API generates a hosted page URL to add new or update existing payment sources for the customer.

        Use one of the following methods to open the hosted page:

        * **In-app modal** : Use Chargebee.js [`openCheckout()`](https://www.chargebee.com/checkout-portal-docs/cbinstanceobj-api-ref.html#opencheckout-options) to open the hosted page in a modal popup in your website or application.
        * **Standalone page** : Redirect the customer to the hosted page `url`.

        Do not embed the hosted page in your own [iframe](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/iframe).
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                business_entity_id:
                  type: string
                  deprecated: false
                  description: |
                    The unique ID of the [business entity](/docs/api/business_entities) of this hosted page. This is always the same as the business entity of the customer.
                  maxLength: 50
                  example: null
                brand_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [brand](/docs/api/brands) this\
                    \ hosted page should be linked to. Applicable only when multiple\
                    \ brands have been created for the site. This need not match the\
                    \ brand of the customer or subscription in the request; when the\
                    \ two differ, the value provided here is used for the hosted page.\
                    \ An alternative way of passing this parameter is by means of\
                    \ the `chargebee-brand-id` custom HTTP header; when both are provided,\
                    \ they must specify the same brand.  \n**Default behavior**\n\n\
                    * When not provided, the hosted page is linked to the brand of\
                    \ the customer or subscription in the request.\n"
                  maxLength: 50
                  example: null
                redirect_url:
                  type: string
                  deprecated: false
                  description: |
                    URL to redirect after payment method is added.
                  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: |
                      Resource object representing hosted_page
                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:
      tags:
      - subscriptions
      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: |
          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: 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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
                  estimate:
                    $ref: "#/components/schemas/Estimate"
                    description: |
                      Resource object representing estimate
                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_for_items:
    post:
      tags:
      - estimates
      summary: Estimate for creating a customer and subscription
      description: "Generates an estimate for creating a subscription when the customer\
        \ does not exist in Chargebee. This estimate API can be called when the customer\
        \ has not yet signed up and you want to preview how a new subscription would\
        \ look like for them.  \n**Note:**\nEstimate operations do not make any changes\
        \ in Chargebee; hence this API does not create an actual `customer`\nor `subscription`\n\
        record.\n\nThe response contains one or more of the following objects:\n\n\
        * `subscription_estimate`: The subscription details like the status of the\
        \ subscription (such as `in_trial` or `active`), next billing date, and so\
        \ on.\n* `invoice_estimate`:The details of the immediate invoice, if there\
        \ is one. If the subscription is created in `trial`/`future` states, `invoice_estimate`\
        \ is unavailable as no immediate invoice is generated.\n* `next_invoice_estimate`:This\
        \ is returned when an immediate invoice is not generated. It contains the\
        \ details of the invoice that will be generated on the next billing date of\
        \ the subscription.\n* `unbilled_charge_estimates`: This contains the details\
        \ of charges that have not been invoiced. This is returned only if the `invoice_immediately`\
        \ parameter is set to `false`.\n"
      operationId: estimate_for_creating_a_customer_and_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                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-item price](/docs/api/item_prices/item_price-object#billing_cycles)
                    is used.
                  minimum: 0
                  example: null
                mandatory_items_to_remove:
                  type: array
                  deprecated: false
                  description: |
                    Item ids of [mandatorily attached addons](/docs/api/attached_items)
                    that are 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: "If there are charges raised immediately for the subscription,\
                    \ this parameter specifies whether those charges are to be invoiced\
                    \ immediately or added to [unbilled charges](https://www.chargebee.com/docs/unbilled-charges.html).\n\
                    The default value is as per the [site settings](https://www.chargebee.com/docs/unbilled-charges.html#configuration)\n\
                    .  \n**Note:**\n`invoice_immediately`\nonly 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.\n\n.\n"
                  example: null
                invoice_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    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.
                    `taxes`
                    and
                    `line_item_taxes`
                    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.
                  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
                    trial_end:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        End of the trial period for the subscription. This overrides the trial period set for the plan-item. The value must be later than `start_date`.
                        Set it to `0`
                        to have no trial period.
                      example: null
                    start_date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        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:

                        * Backdating is enabled for subscription creation operations.
                        * 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.
                        * 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, `start_date` cannot be earlier than 14th February.
                      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: |
                        Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as `billing_cycles`
                        or a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)
                        .
                      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/2.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/2.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/2.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
                  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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ).
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ).
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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: |
                        An overridden value for the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number).
                        Only applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)

                        `country`
                        as `XI`
                        (which is **United Kingdom - Northern Ireland**
                        ).

                        When you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)
                        in 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)
                        the Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)

                        `country`
                        as `XI`.
                        That's the code for **United Kingdom - Northern Ireland** .
                        The first two characters of the VAT number in such a case is
                        `XI`
                        by default. However, if the VAT number was registered in UK, the value should be `GB`.
                        Set
                        `vat_number_prefix`
                        to `GB`
                        for such cases.
                      maxLength: 10
                      example: null
                    registered_for_gst:
                      type: boolean
                      deprecated: false
                      description: |
                        Confirms that a customer is registered under GST. If set to `true`
                        then the [Reverse Charge Mechanism](https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism)
                        is applicable. This field is applicable only when Australian GST is configured for your site.
                      example: null
                    taxability:
                      type: string
                      default: taxable
                      deprecated: false
                      description: |
                        Specifies if the customer is liable for tax

                        * exempt -
                          * Customer is exempted from tax. When using Chargebee's native [Taxes](https://www.chargebee.com/docs/tax.html) feature or when using the [TaxJar integration](https://www.chargebee.com/docs/taxjar.html), no other action is needed.
                          * However, when using our [Avalara integration](https://www.chargebee.com/docs/avalara.html), optionally, specify `entity_code` or `exempt_number` attributes if you use Chargebee's [AvaTax for Sales](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption) or specify `exemption_details` attribute if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. Tax may still be applied by Avalara for certain values of `entity_code`/`exempt_number`/`exemption_details` based on the state/region/province of the taxable address.
                        * zero_rated - This option is available only when zero-rated customer taxability is enabled for the site and the site uses [Chargebee Taxes](https://www.chargebee.com/docs/tax.html); third-party tax providers and integrations are not supported. Otherwise taxable line items for the customer are taxed at 0%. These line items have `is_taxed` set to `true`, the tax rate and tax amount set to `0`, and `tax_exempt_reason` set to `zero_rated`. Unlike `exempt`, this option follows the taxable tax path at a zero rate.
                        * taxable -
                          Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html).
                          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.
                      enum:
                      - taxable
                      - exempt
                      - zero_rated
                      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: |
                        Action to be taken when the contract term completes.

                        * evergreen - Contract term completes and the subscription renews.
                        * renew -
                          * Contract term completes and a new contract term is started for the number of billing cycles specified in [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).
                          * The `action_at_term_end` for the new contract term is set to `renew`.
                        * cancel - Contract term completes and subscription is canceled.
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      default: 0
                      deprecated: false
                      description: |
                        The number of days before [`contract_end`](/docs/api/contract_terms/contract_term-object#contract_end)
                        , 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.
                      example: null
                  example: null
                subscription_items:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription_items
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The unique identifier of the item price.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        The quantity of the item purchased
                      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 item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        The price/per unit price of the item. When not provided, [the value set](/docs/api/item_prices/item-price-object)
                        for the item price is used. This is only applicable when the `pricing_model`
                        of the item price is `flat_fee`
                        or `per_unit`.
                        Also, it is only allowed when [price overriding](https://www.chargebee.com/docs/price-override.html)
                        is enabled for the site. The value depends on the type of currency. If `changes_scheduled_at`
                        is in the past and a `unit_price`
                        is not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](https://www.chargebee.com/docs/2.0/price-override.html)
                        is enabled for the site, the price or per-unit price of the item can be set here. The [value set for the item price](/docs/api/item_prices/item_price-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/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        For the plan-item price:
                        the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then [the value set](/docs/api/item_prices/item-price-object)
                        for the plan-item price is used.

                        For addon-item prices:
                        If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)
                        are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then [the value set under attached addons](/docs/api/attached_items/attached-item-object)
                        is used. Further, if that value is not provided, then [the value set for the addon-item price](/docs/api/item_prices/item-price-object)
                        is used.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    trial_end:
                      type: array
                      description: |
                        The date/time when the trial period of the item ends. Applies to plan-items and--when [enabled](https://www.chargebee.com/docs/2.0/addons-trial.html)
                        --addon-items as well.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    service_period_days:
                      type: array
                      description: |
                        The service period of the item in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 730
                        minimum: 1
                        example: null
                      example: null
                    charge_on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          When `charge_on_option`
                          option is set to `on_event`
                          , this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.

                          * contract_termination -
                            when a contract term is [terminated](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option)
                            .
                          * subscription_trial_start - the time when the trial period of the subscription begins.
                          * plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                          * subscription_activation -
                            the moment a subscription enters an `active`
                            or `non-renewing`
                            state. Also includes reactivations of canceled subscriptions.
                          * subscription_creation - the time of creation of the subscription.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        Indicates if the charge-item is to be charged only once or each time the `charge_on_event`
                        occurs. This parameter only applies to charge-items.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    description:
                      type: array
                      description: "**Limited availability**\n\nSubscription-level\
                        \ item descriptions are available only on sites where this\
                        \ feature is enabled. Please reach out to the 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\nA description for this item that\
                        \ applies only to this subscription. When set, it is used\
                        \ on the customer-facing invoice instead of the description\
                        \ configured for the item price, and is returned as `entity_description`\
                        \ on the invoice [line item](/docs/api/invoices/invoice-object#invoice_line_items).\
                        \ When not set, the description configured for the item price\
                        \ is used.  \n**Constraints**\n\n* Maximum 500 characters.\n\
                        * Whether a description is shown on the invoice at all continues\
                        \ to be controlled by the item price's [show_description_in_invoices](/docs/api/item_prices#show_description_in_invoices)\
                        \ setting. This parameter determines which description is\
                        \ shown, not whether one is shown.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 500
                        example: null
                      example: null
                    charge_on_option:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates when the charge-item is to be charged. This parameter only applies to charge-items.

                          * on_event -
                            The item is charged at the occurrence of the event specified as `charge_on_event`
                            .
                          * immediately - The item is charged immediately on being added to the subscription.
                        enum:
                        - immediately
                        - on_event
                        example: null
                      example: null
                  required:
                  - item_price_id
                  example: null
                discounts:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for discounts
                  properties:
                    apply_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The amount on the invoice to which the discount is applied.

                          * invoice_amount -
                            The discount is applied to the invoice `sub_total`
                            .
                          * specific_item_price -
                            The discount is applied to the `invoice.line_item.amount`
                            that corresponds to the item price specified by `item_price_id`
                            .
                        enum:
                        - invoice_amount
                        - specific_item_price
                        example: null
                      example: null
                    duration_type:
                      type: array
                      items:
                        type: string
                        default: forever
                        deprecated: false
                        description: |
                          Specifies the time duration for which this discount is attached to the subscription.

                          * forever -
                            The discount is attached to the subscription and applied on the invoices till it is [explicitly removed](/docs/api/subscriptions/update-subscription-for-items#discounts_operation_type)
                            .
                          * 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 `period`
                            and `period_unit`
                            .
                          * one_time -
                            The discount stays attached to the subscription till it is applied on an invoice **once**.
                            It is removed after that from the subscription.
                        enum:
                        - one_time
                        - forever
                        - limited_period
                        example: null
                      example: null
                    percentage:
                      type: array
                      description: |
                        The percentage of the original amount that should be deducted from it.
                      items:
                        type: number
                        format: double
                        deprecated: false
                        maximum: 100
                        minimum: 0.01
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        The value of the discount. [The format of this value](/docs/api/currencies)
                        depends on the kind of currency.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    period:
                      type: array
                      description: |
                        The duration of time for which the discount is attached to the subscription, in `period_units`.
                        Applicable only when `duration_type`
                        is `limited_period`.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    period_unit:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The unit of time for `period`.
                          Applicable only when `duration_type`
                          is `limited_period`.

                          * day - A period of 24 hours.
                          * week - A period of 7 days.
                          * month - A period of 1 calendar month.
                          * year - A period of 1 calendar year.
                        enum:
                        - day
                        - week
                        - month
                        - year
                        example: null
                      example: null
                    included_in_mrr:
                      type: array
                      description: |
                        The discount is included in MRR calculations for your site. This attribute is only applicable when `duration_type`
                        is `one_time`
                        and when the [feature is enabled](https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation)
                        in Chargebee. Also, If the [site-level setting](https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation)
                        is to exclude one-time discounts from MRR calculations, this value is always returned `false`.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    item_price_id:
                      type: array
                      description: |
                        The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                        in the subscription to which the discount is to be applied. Relevant only when `apply_on`
                        = `specific_item_price`.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Specifies the number of free units provided for the item, without affecting the total quantity sold
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                  required:
                  - duration_type
                  example: null
                item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_tiers
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The id of the item price for which the tier price is being overridden.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: |
                        The lowest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The highest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |
                        The overridden price of the tier. The value depends on the [type of currency](/docs/api/estimates)
                        .
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    pricing_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Pricing type for the tier.

                          * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                          * flat_fee -
                            Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                            pricing model, `pricing_type`
                            will be set to `flat_fee`
                            by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                          * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                        enum:
                        - per_unit
                        - flat_fee
                        - package
                        example: null
                      example: null
                    package_size:
                      type: array
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        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
              contract_term:
                style: deepObject
                explode: true
              customer:
                style: deepObject
                explode: true
              discounts:
                style: deepObject
                explode: true
              item_tiers:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              subscription:
                style: deepObject
                explode: true
              subscription_items:
                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: |
                      Resource object representing estimate
                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/payment_schedules:
    post:
      tags:
      - estimates
      summary: Create a payment schedule estimate
      description: |
        Generates an estimate without creating a payment schedule. This endpoint can be called when you want to preview details of a new payment schedule before actually creating one.
      operationId: estimates_for_payment_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                scheme_id:
                  type: string
                  deprecated: false
                  description: |
                    The unique identifier for the `payment_schedule_scheme`.
                    This identifier is used to retrieve the payment schedule scheme, which is then applied to calculate the amount and date for the specified number of payment schedules.
                  example: null
                amount:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    Defines the payment schedule amount set for an invoice. If this is not provided, the total `invoice.amount_due`
                    is used. This value is mandatory in case `invoice_id`
                    is not provided.
                  minimum: 0
                  example: null
                invoice_id:
                  type: string
                  deprecated: false
                  description: |
                    Unique identifier of the invoice.
                  example: null
                payment_schedule_start_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The date from which the payment schedule will start. This is applicable only when invoice_id is not provided. If `invoice_id`
                    is provided, we will consider `invoice.due_date`
                    .
                  example: null
              required:
              - scheme_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  estimate:
                    $ref: "#/components/schemas/Estimate"
                    description: |
                      Resource object representing estimate
                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_for_items_estimate:
    post:
      tags:
      - subscriptions
      summary: Cancel subscription for items estimate
      description: |
        Creates an estimate for [canceling](/docs/api/subscriptions/cancel-subscription-for-items) the specified subscription.
      operationId: cancel_subscription_for_items_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    ##### If the subscription does not have a contract term:

                    Determines when to cancel the subscription.

                    ##### If the subscription has a contract term:

                    This parameter is not applicable.

                    * end_of_billing_term - This is used to cancel a subscription either at the end of the advance term, if it's billed for future renewals or at the end of its current billing cycle
                    * end_of_term - This is used to cancel a subscription at the end of the current billing cycle
                    * immediately - This is used to cancel the subscription with immediate effect
                    * specific_date - This is used to cancel a subscription on a specified date. The change occurs as of the date/time defined in `cancel_at`
                  enum:
                  - immediately
                  - end_of_term
                  - specific_date
                  - end_of_billing_term
                  example: null
                end_of_term:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    **(Deprecated)** Use `cancel_option` instead.
                    Applicable only when the subscription does not have [contract terms](/docs/api/contract_terms).
                    Set this to `true` if you want to cancel the subscription at the end of the current subscription billing cycle. The subscription `status` changes to `non_renewing`.
                  example: null
                cancel_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    ##### If the subscription does not have a contract term:

                    Specifies the date and time when the subscription should be canceled. Do not use this parameter when `end_of_term` is set to `true`.

                    ##### If the subscription has a contract term:

                    Applicable only when `contract_term_cancel_option` is `specific_date`. Specifies the date and time to cancel the subscription and contract term.

                    ##### Backdating

                    You can set a past date to backdate the cancellation. Backdating is allowed only if the following conditions are met:

                    * [Backdating](https://www.chargebee.com/docs/2.0/backdating.html) is enabled for subscription cancellation.
                    * The current date does not exceed the [backdating limit configured in Chargebee Billing](https://www.chargebee.com/docs/2.0/backdating.html#configuring-backdated-subscription-actions-and-invoicing).
                    * The date is on or after the `current_term_start`.
                    * The date is on or after the most recent change involving:
                      * Addition/change/removal of plan or addon item prices.
                      * Addition of charge item prices.
                    * The date is not more than one billing period into the past. For example, if the plan's billing period is two months and today is April 14, `cancel_at` cannot be earlier than February 14.
                  example: null
                credit_option_for_current_term_charges:
                  type: string
                  deprecated: false
                  description: |
                    ##### If the subscription does not have a contract term:

                    Specifies how to handle credits for current term charges when canceling immediately (i.e., `cancel_option` is `immediately`). If not specified, the [site-level setting](https://www.chargebee.com/docs/2.0/cancellations.html#configure-subscription-cancellation) is used.

                    ##### If the subscription has a contract term:

                    Specifies how to handle credits for current term charges when `contract_term_cancel_option` is `terminate_immediately`. If not specified, the [site-level setting](https://www.chargebee.com/docs/2.0/contract-terms.html#configuring-contract-terms) is used.

                    * none - No credits notes are created.
                    * full - Credits are issues for the full value of the current term charges.
                    * prorate - Prorated credits are issued.
                  enum:
                  - none
                  - prorate
                  - full
                  - consumption_based
                  example: null
                unbilled_charges_option:
                  type: string
                  deprecated: false
                  description: |
                    ##### If the subscription does not have a contract term:

                    Specifies how to handle unbilled charges when canceling immediately (i.e., `cancel_option` is `immediately`). If not specified, the [site-level setting](https://www.chargebee.com/docs/2.0/cancellations.html#configure-subscription-cancellation) is used.

                    ##### If the subscription has a contract term:

                    Specifies how to handle unbilled charges when `contract_term_cancel_option` is `terminate_immediately`. If not specified, the [site-level setting](https://www.chargebee.com/docs/2.0/contract-terms.html#configuring-contract-terms) is used.

                    * invoice - An invoice is generated immediately with the unbilled charges.
                    * delete - The unbilled charges are deleted.
                  enum:
                  - invoice
                  - delete
                  example: null
                account_receivables_handling:
                  type: string
                  deprecated: false
                  description: |
                    ##### If the subscription does not have a contract term:

                    Specifies how to handle past due invoices when canceling immediately (i.e., `cancel_option` is `immediately`). If not specified, the [site-level setting](https://www.chargebee.com/docs/2.0/cancellations.html#configure-subscription-cancellation) is used.

                    ##### If the subscription has a contract term:

                    Specifies how to handle past due invoices when `contract_term_cancel_option` is `terminate_immediately`. If not specified, the [site-level setting](https://www.chargebee.com/docs/2.0/contract-terms.html#configuring-contract-terms) is used.

                    * no_action - No action is taken.
                    * write_off -
                      Applies excess payments and refundable credits to past due invoices. Any remaining balance is written off.

                      *Note: The credit note for the write-off is not included in the API response.*
                    * schedule_payment_collection -
                      Applies excess payments and refundable credits to past due invoices. If any amount remains and `auto_collection`
                      is `on`
                      , the remaining amount is automatically charged to the available payment method.
                  enum:
                  - no_action
                  - schedule_payment_collection
                  - write_off
                  example: null
                refundable_credits_handling:
                  type: string
                  deprecated: false
                  description: |
                    ##### If the subscription does not have a contract term:

                    Specifies how to handle refundable credits when canceling immediately (i.e., `cancel_option` is `immediately`). If not specified, the [site-level setting](https://www.chargebee.com/docs/2.0/cancellations.html#configure-subscription-cancellation) is used.

                    ##### If the subscription has a contract term:

                    Specifies how to handle refundable credits when `contract_term_cancel_option` is `terminate_immediately`. If not specified, the [site-level setting](https://www.chargebee.com/docs/2.0/contract-terms.html#configuring-contract-terms) is used.

                    * schedule_refund - Refunds remaining credits after applying them to any past due invoices.
                    * no_action - No action is taken.
                  enum:
                  - no_action
                  - schedule_refund
                  example: null
                contract_term_cancel_option:
                  type: string
                  deprecated: false
                  description: |
                    Required when the subscription has a contract term. Determines when to cancel the subscription along with the contract term.

                    * terminate_immediately -
                      Cancels the subscription and contract term immediately. Sets the contract term's `status` to `terminated` and collects any termination fee, if applicable.

                      To specify the termination fee, include a single object in the `subscription_items` array. If not specified, the [default termination fee](/docs/api/contract_terms) is applied (if configured).
                    * end_of_contract_term - Prevents the contract term from renewing and schedules the subscription for cancellation at the end of the contract term.
                    * specific_date -
                      Cancels the subscription and contract term on the date specified by `cancel_at`. Sets `action_at_term_end` to `cancel`.

                      **Note** : 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) to enable this option for your [Chargebee site](https://www.chargebee.com/docs/2.0/sites-intro.html).
                    * end_of_subscription_billing_term -
                      Cancels the subscription and contract term at the end of the current billing cycle. Sets `action_at_term_end` to `cancel`.

                      **Note** : 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) to enable this option for your [Chargebee site](https://www.chargebee.com/docs/2.0/sites-intro.html).
                  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: |
                    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 `create_pending_invoices`
                    is `true`
                    , 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 `invoice_date`.
                    When passing this parameter, the following prerequisites must be met:

                    * `invoice_date` must be in the past.
                    * `invoice_date` 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.
                    * It is not earlier than `cancel_at`. .
                  example: null
                include_cancellation_day_in_billing:
                  type: boolean
                  deprecated: false
                  description: |
                    Determines whether the cancellation day is included in the billing period when prorated credits are issued for the current term charges.
                    Set to `true` to bill the customer for the cancellation day (the term ends on the cancellation date), or `false` to exclude it (the term ends the day before). If not specified, the [site-level setting](https://www.chargebee.com/docs/2.0/cancellations.html#configure-subscription-cancellation) is used.
                    This parameter is applicable only for sites using Day-Based Billing, when:

                    * the subscription is `active` or `non_renewing`,
                    * the subscription is canceled immediately, on a backdated date, or on a specific date within the current term, and
                    * `credit_option_for_current_term_charges` is set to `prorate`.

                    **Note**: Passing this parameter in any other scenario results in a validation error.
                  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
                subscription_items:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription_items
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The unique `id`
                        of the charge item_price that represents the termination fee.
                      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 item_price for the termination charge is quantity-based.
                      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 item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        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
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](https://www.chargebee.com/docs/2.0/price-override.html)
                        is enabled for the site, the price or per-unit price of the item can be set here. The [value set for the item price](/docs/api/item_prices/item_price-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/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    service_period_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: 730
                        minimum: 1
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              subscription_items:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  estimate:
                    $ref: "#/components/schemas/Estimate"
                    description: |
                      Resource object representing estimate
                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:
      tags:
      - subscriptions
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing estimate
                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_for_items:
    post:
      tags:
      - estimates
      summary: Create invoice for items estimate
      description: |
        This endpoint creates an invoice estimate for non-recurring items.

        You can optionally override the line item name and description displayed on the invoice for charge-item prices and one-time charges. These overrides are reflected in the returned invoice estimate.
      operationId: create_invoice_for_items_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    Set as `true`
                    to remove the [**general note**](https://www.chargebee.com/docs/invoice_notes.html#adding-general-notes)
                    from this invoice.
                  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: |
                    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.
                    `taxes`
                    and
                    `line_item_taxes`
                    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.
                  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.
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada and India If `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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:
                    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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ).
                      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
                    country:
                      type: string
                      deprecated: false
                      description: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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
                item_prices:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_prices
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        A unique ID for your system to identify the item price.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Item price quantity
                      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 item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        The price or per-unit-price of the item price. By default, it is the [value set](/docs/api/item_prices/item_price-object#price)
                        for the `item_price`.
                        This is only applicable when the `pricing_model`
                        of the `item_price`
                        is `flat_fee`
                        or `per_unit`.
                        The value depends on the [type of currency](/docs/api/getting-started)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      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/getting-started)
                        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 item 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 item ends.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    description:
                      type: array
                      description: "The line item name to display on the invoice for\
                        \ this charge item.  \n**Default value**\n\n* The invoice\
                        \ name defined for the item in the product catalog.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 250
                        example: null
                      example: null
                    entity_description:
                      type: array
                      description: "Descriptive text displayed below the line item\
                        \ name on the invoice for this charge item.  \n**Default value**\n\
                        \n* The [item price description](/docs/api/item_prices/item_price-object#description)\
                        \ from the product catalog.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 2000
                        example: null
                      example: null
                  example: null
                item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_tiers
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The id of the item price to which this tier belongs.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: |
                        The lowest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The highest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |
                        The per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        The total cost for the item price when the `pricing_model`
                        is `stairstep`.
                        The value is in the minor unit of the currency.
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    pricing_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Pricing type for the tier.

                          * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                          * flat_fee -
                            Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                            pricing model, `pricing_type`
                            will be set to `flat_fee`
                            by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                          * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                        enum:
                        - per_unit
                        - flat_fee
                        - package
                        example: null
                      example: null
                    package_size:
                      type: array
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        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/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    description:
                      type: array
                      description: |
                        The name of this one-time charge as displayed on the invoice line item.
                      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
                          * 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
                          * 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
                    entity_description:
                      type: array
                      description: |
                        Descriptive text for this one-time charge displayed on the invoice, shown below the line item name.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 2000
                        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: |
                          Type of entity to which the [note](/docs/api/invoices/invoice-object#notes)
                          belongs. To remove the general note, use the `remove_general_note`
                          parameter.

                          * 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
                          * plan_item_price - Indicates that this line item is based on plan Item Price
                          * customer - Entity that represents a customer.
                          * subscription - Entity that represents a subscription of customer.
                          * coupon - Entity that represents a coupon.
                        enum:
                        - customer
                        - subscription
                        - coupon
                        - plan_item_price
                        - addon_item_price
                        - charge_item_price
                        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
                discounts:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for discounts
                  properties:
                    percentage:
                      type: array
                      description: |
                        The percentage of the original amount that should be deducted from it.
                      items:
                        type: number
                        format: double
                        deprecated: false
                        maximum: 100
                        minimum: 0.01
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        The value of the discount. [The format of this value](/docs/api/currencies)
                        depends on the kind of currency.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Specifies the number of free units provided for the item, without affecting the total quantity sold
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    apply_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The amount on the invoice to which the discount is applied.

                          * invoice_amount -
                            The discount is applied to the invoice `sub_total`
                            .
                          * specific_item_price -
                            The discount is applied to the `invoice.line_item.amount`
                            that corresponds to the item price specified by `item_price_id`
                            .
                        enum:
                        - invoice_amount
                        - specific_item_price
                        example: null
                      example: null
                    item_price_id:
                      type: array
                      description: |
                        The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                        in the subscription to which the discount is to be applied. Relevant only when `apply_on`
                        = `specific_item_price`.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                  required:
                  - apply_on
                  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
              charges:
                style: deepObject
                explode: true
              discounts:
                style: deepObject
                explode: true
              invoice:
                style: deepObject
                explode: true
              item_prices:
                style: deepObject
                explode: true
              item_tiers:
                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: |
                      Resource object representing estimate
                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_for_items:
    post:
      tags:
      - estimates
      summary: Gift subscription estimate for items
      description: |
        This endpoint generates an estimate for a subscription that is intended to be a gift. The estimate provides details about the gift sender, gift recipient, address details of the recipient, and the type and details of subscription items included in the gift.
      operationId: gift_subscription_estimate_for_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                        When `true`
                        , the claim happens automatically. When not passed, the default value in the site settings is used.
                      example: null
                    no_expiry:
                      type: boolean
                      deprecated: false
                      description: |
                        When `true`
                        , indicates that the gift does not expire. Do not pass or pass as `false`
                        when `auto_claim`
                        is set.
                      example: null
                    claim_expiry_date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The date until which the gift can be claimed. Must be set to a value after `scheduled_at`.
                        If the gift is not claimed within `claim_expiry_date`
                        , it will expire and the subscription will move to `cancelled`
                        state. When not passed, the value specified in the site settings will be used.
                        Pass as `NULL`
                        or do not pass when `auto_claim`
                        or `no_expiry`
                        are set.
                      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
                        * dotpay - dotpay
                        * faster_payments - Faster Payments
                        * upi - upi
                        * kbc_payment_button - KBC Payment Button
                        * klarna - Payments made via Klarna.
                        * payme - Payments made via PayMe
                        * thai_qr - Payments made via Thai QR.
                        * 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.
                        * tamara - Payments made via Tamara.
                        * ideal - ideal
                        * picpay - Payments made via PicPay.
                        * pay_to - PayTo
                        * ovo - Payments made via OVO.
                        * boleto - boleto
                        * pay_co - Payments made via PayCo
                        * wechat_pay - Payments made via WeChat Pay.
                        * cash_app_pay - Payments made via Cash App Pay.
                        * rakuten_pay - Payments made via Rakuten Pay.
                        * alipay_hk - Payments made via Alipay HK.
                        * after_pay - Payments made via Afterpay
                        * netbanking_emandates - netbanking_emandates
                        * nequi - Payments made via Nequi.
                        * grab_pay - Payments made via GrabPay
                        * paypay - PayPay
                        * payconiq_by_bancontact - Payments made via Payconiq by Bancontact.
                        * mercado_pago - Payments made via Mercado Pago.
                        * p24 - Payments made via Przelewy24 (P24).
                        * electronic_payment_standard - Electronic Payment Standard
                        * direct_debit - direct_debit
                        * sepa_instant_transfer - Sepa Instant Transfer
                        * bancontact - bancontact
                        * wero - Payments made via Wero.
                        * pay_by_bank - Pay By Bank
                        * touch_n_go - Payments made via Touch 'n Go.
                        * apple_pay - apple_pay
                        * qpay - Payments made via Qpay.
                        * online_banking_poland - Online Banking Poland
                        * gcash - Payments made via GCash.
                        * nupay - Payments made via NuPay.
                        * giropay - giropay
                        * momo - Payments made via MoMo.
                        * sofort - sofort
                        * amazon_payments - Amazon Payments
                        * affirm_pay - Payments made via Affirm Pay.
                        * kakao_pay - Payments made via Kakao Pay.
                        * fpx - Payments made via FPX.
                        * blik - Payments made via BLIK.
                        * dana - Payments made via Dana.
                        * south_korean_cards - Payments made via South Korean Cards
                        * 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
                      - alipay_hk
                      - paypay
                      - gcash
                      - south_korean_cards
                      - paynow
                      - bizum
                      - promptpay
                      - dana
                      - touch_n_go
                      - tamara
                      - qpay
                      - ovo
                      - momo
                      - mercado_pago
                      - nequi
                      - nupay
                      - picpay
                      - thai_qr
                      - blik
                      - fpx
                      - wero
                      - p24
                      - affirm_pay
                      - rakuten_pay
                      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: |
                        * `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal).

                          * `payer`: User related information.
                            * `country_of_residence`: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a [two-character ISO code](https://docs.checkout.com/resources/codes/country-codes).
                            * `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
                        * `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
                        * `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user's `device_session_id` can be added to perform [additional validation](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                            * `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
                        * `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
                        * `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                        * `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.

                          * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
                        * `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.

                          * `payer`: User related information.
                            * `document`: Document is the user's identification number based on their country.
                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada and India If `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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_items:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription_items
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The unique identifier of the item price.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        The quantity of the item purchased
                      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 item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: "The price/per unit price of the item. The value\
                        \ is interpreted as per the type of [currency](/docs/api/currencies).\
                        \  \n**Prerequisites**\n\n* The `pricing_model` of the item\
                        \ price is `flat_fee` or `per_unit`.\n* [Price overriding](https://www.chargebee.com/docs/price-override.html)\
                        \ is enabled for the site.  \n**Default value**\n\n* [`item_price.price`](/docs/api/item_prices/item_price-object#price).\n"
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: "The price/per unit price of the item in major\
                        \ units of the [currency](/docs/api/currencies). When not\
                        \ provided, the [value set for the item price](/docs/api/item_prices/item_price-object#price)\
                        \ is used.  \n**Prerequisites**\n\n* The `pricing_model` of\
                        \ the item price is `flat_fee` or `per_unit`.\n* [Multi-decimal](https://www.chargebee.com/docs/billing/2.0/site-configuration/multi-decimal-support#configuring-multi-decimal-support)\
                        \ pricing is enabled.\n* [Price overriding](https://www.chargebee.com/docs/2.0/price-override.html)\
                        \ is enabled for the site.  \n**Default value**\n\n* [`item_price.price_in_decimal`](/docs/api/item_prices/item_price-object#price_in_decimal).\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                  example: null
                item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_tiers
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The id of the item price for which the tier price is being overridden.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: "The lowest value in the quantity tier.  \n**Constraints**\n\
                        \n* Must be zero for the lowest tier.\n* For all other tiers,\
                        \ it must be equal to the `ending_unit` of the next lower\
                        \ tier.\n"
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: "The highest value in the quantity tier.  \n**Constraints**\n\
                        \n* Not applicable for the highest tier.\n* Must be equal\
                        \ to the `starting_unit` of the next higher tier.\n"
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |
                        The overridden price of the tier. The value depends on the [type of currency](/docs/api/currencies).
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: "The decimal representation of the lowest value\
                        \ of quantity in this tier.  \n**Constraints**\n\n* Must be\
                        \ zero for the lowest tier.\n* For all other tiers, it must\
                        \ be equal to the `ending_unit_in_decimal` of the next lower\
                        \ tier.  \n**Prerequisite**\n\n* [Multi-decimal](https://www.chargebee.com/docs/billing/2.0/site-configuration/multi-decimal-support#configuring-multi-decimal-support)\
                        \ pricing is enabled.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: "The decimal representation of the highest value\
                        \ of quantity in this tier.  \n**Constraints**\n\n* Not applicable\
                        \ for the highest tier.\n* Must be equal to the `starting_unit_in_decimal`\
                        \ of the next higher tier.  \n**Prerequisite**\n\n* [Multi-decimal](https://www.chargebee.com/docs/billing/2.0/site-configuration/multi-decimal-support#configuring-multi-decimal-support)\
                        \ pricing is enabled.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: "* The decimal representation of the per-unit price\
                        \ for the tier when the [item_price.pricing_model](/docs/api/item_prices/item_price-object#pricing_model)\
                        \ is `tiered` or `volume`.\n* The decimal representation of\
                        \ the total price for the item when the [item_price.pricing_model](/docs/api/item_prices/item_price-object#pricing_model)\
                        \ is `stairstep`.\n\n**Constraints**\n\n* The value must be\
                        \ in major units of the [currency](/docs/api/currencies).\
                        \  \n**Prerequisite**\n\n* [Multi-decimal](https://www.chargebee.com/docs/billing/2.0/site-configuration/multi-decimal-support#configuring-multi-decimal-support)\
                        \ pricing is enabled.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              gift:
                style: deepObject
                explode: true
              gift_receiver:
                style: deepObject
                explode: true
              gifter:
                style: deepObject
                explode: true
              item_tiers:
                style: deepObject
                explode: true
              payment_intent:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              subscription_items:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  estimate:
                    $ref: "#/components/schemas/Estimate"
                    description: |
                      Resource object representing estimate
                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_for_items:
    post:
      tags:
      - estimates
      summary: Estimate for updating a subscription
      description: |
        Returns an estimate for updating a subscription.

        In the response,

        * [subscription_estimate](/docs/api/estimates/estimate-object): The details of the changed subscription such as `status`, next billing date, and so on.
        * [invoice_estimate](/docs/api/estimates/estimate-object):The details of the immediate invoice, if it is generated. An immediate invoice is not generated when:
          * `end_of_term` parameter is true
          * `prorate` parameter is `false`
          * No changes are made to the plan item prices or addon item prices in `subscription_items`.
          * For changes such as [quantity downgrades](https://www.chargebee.com/docs/proration.html#proration-mechanism_plan-quantity-downgrade-paid-invoice).
        * [next_invoice_estimate](/docs/api/estimates/estimate-object):The details of the invoice to be generated later (if any) on the occasion that no immediate invoice has been generated.
        * [credit_note_estimates](/docs/api/estimates/estimate-object):The list of credit notes (if any) generated during this operation.
        * [unbilled_charge_estimates](/docs/api/estimates/estimate-object): The details of charges that have not been invoiced. This is returned only if the `invoice_immediately` parameter is set to `false`.

        The following conditions must be met or **tax calculation** is ignored:

        * The `taxability` [attribute](/docs/api/customers/customer-object#taxability) for the customer is `true`.
        * Necessary parameters for tax calculation such as the following are passed: `billing_address`, `shipping_address`, `customer[vat_number]`
      operationId: estimate_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                changes_scheduled_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: "When `change_option` is set to `specific_date`, then\
                    \ set the date/time at which the subscription change is to happen\
                    \ or has happened.  \n**Constraints**\n\n* Do not pass this parameter\
                    \ along with `reactivate_from`.\n* The `changes_scheduled_at`\
                    \ parameter does not apply to `auto_collection`, `shipping_address`,\
                    \ and `po_number`; these parameters take effect **immediately**\
                    \ when scheduling a subscription update.  \n**Backdated changes**\n\
                    \n`changes_scheduled_at`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:\n\n* Backdating must be\
                    \ enabled for subscription change operations.\n* Only the following\
                    \ changes can be backdated:\n  * Changes in the recurring items\
                    \ or their prices.\n  * Addition of non-recurring items.\n* Subscription\
                    \ `status` is `active`, `cancelled`, or `non_renewing`.\n* 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.\n* The date is on or after `current_term_start`.\n\
                    * The date is on or after the last date/time any of the following\
                    \ changes were made:\n  * Changes in the recurring items or their\
                    \ prices.\n  * Addition of non-recurring items.\n* 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, `changes_scheduled_at`\
                    \ cannot be earlier than 14th February.\n"
                  example: null
                change_option:
                  type: string
                  deprecated: false
                  description: |
                    Specifies the effective date for the subscription change.

                    * end_of_term - The change is carried out at the end of the current billing cycle of the subscription.
                    * specific_date - Executes the change on a specified date. The change occurs as of the date/time defined in `changes_scheduled_at`.
                    * immediately - The change is carried out immediately.
                  enum:
                  - immediately
                  - end_of_term
                  - specific_date
                  example: null
                mandatory_items_to_remove:
                  type: array
                  deprecated: false
                  description: |
                    Item ids of [mandatorily attached addons](/docs/api/attached_items)
                    that are to be removed from the subscription.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                replace_items_list:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    If `true`
                    then the existing `subscription_items`
                    list for the subscription is replaced by the one provided. If `false`
                    then the provided `subscription_items`
                    list gets added to the existing list.
                  example: null
                invoice_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    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 `create_pending_invoices`
                    is set to `true`
                    , 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 `invoice_date`.
                    When passing this parameter, the following prerequisites must be met:

                    * `invoice_date` must be in the past.
                    * `invoice_date` 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.
                    * It is not earlier than `changes_scheduled_at`, `reactivate_from`, or `trial_end`.
                    * `invoice_immediately` is `true`. .
                  example: null
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Billing cycles set for plan-item price is used by default.
                  minimum: 0
                  example: null
                terms_to_charge:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of subscription billing cycles to [invoice in advance](https://www.chargebee.com/docs/advance-invoices.html).
                    If a new term is started for the subscription due to this API call, then `terms_to_charge`
                    is inclusive of this new term. See description for the `force_term_reset`
                    parameter to learn more about when a subscription term is reset.
                  minimum: 1
                  example: null
                reactivate_from:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    If the subscription `status`
                    is `cancelled`
                    and it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.
                    **Note:**
                    It is recommended not to pass this parameter along with `changed_scheduled_at`.
                    `reactivate_from`
                    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:

                    * Backdating must be enabled for subscription reactivation operations.
                    * 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.
                    * The date is on or after the last date/time any of the product catalog items of the subscription were changed.
                    * 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, `changes_scheduled_at` cannot be earlier than 14th February. .
                  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: |
                    If `true`
                    then the existing `coupon_ids`
                    list for the subscription is replaced by the one provided. If `false`
                    then the provided list gets added to the existing `coupon_ids`
                    .
                  example: null
                prorate:
                  type: boolean
                  deprecated: false
                  description: |
                    * When `true`: [Prorated credits or charges](https://www.chargebee.com/docs/2.0/proration.html#proration-mechanism) are created as applicable for this change.
                    * When `false`: The subscription is changed without creating any credits or charges.
                    * When not provided, the value configured in the [site settings](https://www.chargebee.com/docs/2.0/proration.html#proration-for-subscription-change) is considered.

                    **Caveat**

                    For further changes within the same billing term, when `prorate` is set to `true`, **credits** are **not created** when **all** the conditions below hold true:

                    An immediate previous change was made

                    * with `prorate` set to `false` and
                    * no changes were made to the subscription's billing term and
                    * a change was made to either the subscription's items or their prices.
                  example: null
                end_of_term:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    **Deprecated**

                    * Use `change_option` instead.
                    * If you pass this parameter along with `change_option`, then `change_option` wins.

                    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: |
                    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 `true`
                    will have the subscription reset its term to the current date (provided `end_of_term`
                    is false).
                    **Note**:
                    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.
                  example: null
                reactivate:
                  type: boolean
                  deprecated: false
                  description: |
                    Applicable only for `cancelled`
                    subscriptions. When passed as `true`
                    , the canceled subscription is activated; otherwise subscription changes are made without changing its `status`.
                    If not passed, subscription will be activated only if `subscription_items`
                    is passed.
                  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: "If there are charges raised immediately for the subscription,\
                    \ this parameter specifies whether those charges are to be invoiced\
                    \ immediately or added to [unbilled charges](https://www.chargebee.com/docs/unbilled-charges.html).\n\
                    The default value is as per the [site settings](https://www.chargebee.com/docs/unbilled-charges.html#configuration)\n\
                    .  \n**Note:**\n`invoice_immediately`\nonly 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.\n\n.\n"
                  example: null
                invoice_usages:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Setting this attribute to `true` will invoice the overages for the metered item during subscription changes
                    .
                  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
                    start_date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The new start date of a `future`
                        subscription. Applicable only for `future`
                        subscriptions.
                      example: null
                    trial_end:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The time at which the trial has ended or will end for the subscription. This is only allowed when the subscription `status`
                        is `future`
                        , `in_trial`
                        , or `cancelled`.
                        Also, the value must not be earlier than `changes_scheduled_at`
                        or `start_date`.
                        **Note** :
                        This parameter can be backdated (set to a value in the past) only when the subscription is in `cancelled`
                        or `in_trial`
                        `status`.
                        Do this to keep a record of when the trial ended in case it ended at some point in the past. When `trial_end`
                        is backdated, the subscription immediately goes into `active`
                        or `non_renewing`
                        status.
                      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: |
                        Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/2.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/2.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/2.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:
                  - 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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ).
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ).
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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: |
                        An overridden value for the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number).
                        Only applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)

                        `country`
                        as `XI`
                        (which is **United Kingdom - Northern Ireland**
                        ).

                        When you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)
                        in 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)
                        the Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)

                        `country`
                        as `XI`.
                        That's the code for **United Kingdom - Northern Ireland** .
                        The first two characters of the VAT number in such a case is
                        `XI`
                        by default. However, if the VAT number was registered in UK, the value should be `GB`.
                        Set
                        `vat_number_prefix`
                        to `GB`
                        for such cases.
                      maxLength: 10
                      example: null
                    registered_for_gst:
                      type: boolean
                      deprecated: false
                      description: |
                        Confirms that a customer is registered under GST. If set to `true`
                        then the [Reverse Charge Mechanism](https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism)
                        is applicable. This field is applicable only when Australian GST is configured for your site.
                      example: null
                  example: null
                billing_override:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for billing_override
                  properties:
                    max_excess_payment_usage:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Maximum amount of [excess payments](/docs/api/customers/customer-object#excess_payments) that can be automatically applied to a single invoice associated with this subscription.

                        **Supported values:**

                        * `-1`: Set to `-1` to reset the subscription-level limit. In this case, the site-level configuration will apply, whether it is configured to Auto Apply or Do Not Auto Apply excess payments.
                        * `0`: Disable auto-application for the subscription. No excess payments will be automatically applied to invoices.
                        * Any positive value: Specifies the maximum amount of excess payments that can be automatically applied to a single invoice for this subscription.
                      minimum: -1
                      example: null
                    max_refundable_credits_usage:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Maximum amount of [refundable credits](/docs/api/customers/customer-object#refundable_credits) that can be automatically applied to a single invoice associated with this subscription.

                        **Supported values:**

                        * `-1`: Set to `-1` to reset the subscription-level limit. In this case, the site-level configuration will apply, whether it is configured to Auto Apply or Do Not Auto Apply refundable credits.
                        * `0`: Disable auto-application for the subscription. No refundable credits will be automatically applied to invoices.
                        * Any positive value: Specifies the maximum amount of refundable credits that can be automatically applied to a single invoice for this subscription.
                      minimum: -1
                      example: null
                  example: null
                subscription_items:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription_items
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The unique identifier of the item price.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        The quantity of the item purchased
                      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 item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        The price/per unit price of the item. When not provided, [the value set](/docs/api/item_prices/item-price-object)
                        for the item price is used. This is only applicable when the `pricing_model`
                        of the item price is `flat_fee`
                        or `per_unit`.
                        Also, it is only allowed when [price overriding](https://www.chargebee.com/docs/price-override.html)
                        is enabled for the site. The value depends on the type of currency. If `changes_scheduled_at`
                        is in the past and a `unit_price`
                        is not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](https://www.chargebee.com/docs/price-override.html)
                        is enabled for the site, the price or per-unit price of the item can be set here. The [value set for the item price](/docs/api/item_prices/item_price-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/getting-started)
                        is enabled. If `changes_scheduled_at`
                        is in the past and a `unit_price_in_decimal`
                        is not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        For the plan-item price:
                        the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then [the value set](/docs/api/item_prices/item-price-object)
                        for the plan-item price is used.

                        For addon-item prices:
                        If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)
                        are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then [the value set under attached addons](/docs/api/attached_items/attached-item-object)
                        is used. Further, if that value is not provided, then [the value set for the addon-item price](/docs/api/item_prices/item-price-object)
                        is used.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    trial_end:
                      type: array
                      description: |
                        The date/time when the trial period of the item ends. Applies to plan-items and--when [enabled](https://www.chargebee.com/docs/2.0/addons-trial.html)
                        --addon-items as well.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    service_period_days:
                      type: array
                      description: |
                        The service period of the item in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 730
                        minimum: 1
                        example: null
                      example: null
                    charge_on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          When `charge_on_option`
                          option is set to `on_event`
                          , this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.

                          * contract_termination -
                            when a contract term is [terminated](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option)
                            .
                          * subscription_trial_start - the time when the trial period of the subscription begins.
                          * plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                          * subscription_activation -
                            the moment a subscription enters an `active`
                            or `non-renewing`
                            state. Also includes reactivations of canceled subscriptions.
                          * subscription_creation - the time of creation of the subscription.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        Indicates if the charge-item is to be charged only once or each time the `charge_on_event`
                        occurs. This parameter only applies to charge-items.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    charge_on_option:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates when the charge-item is to be charged. This parameter only applies to charge-items.

                          * on_event -
                            The item is charged at the occurrence of the event specified as `charge_on_event`
                            .
                          * immediately - The item is charged immediately on being added to the subscription.
                        enum:
                        - immediately
                        - on_event
                        example: null
                      example: null
                    description:
                      type: array
                      description: "**Limited availability**\n\nSubscription-level\
                        \ item descriptions are available only on sites where this\
                        \ feature is enabled. Please reach out to the 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\nA description for this item that\
                        \ applies only to this subscription. When set, it is used\
                        \ on the customer-facing invoice instead of the description\
                        \ configured for the item price, and is returned as `entity_description`\
                        \ on the invoice [line item](/docs/api/invoices/invoice-object#invoice_line_items).\n\
                        \nOmit this parameter to retain the description currently\
                        \ stored for the item. Pass an empty value to remove it, after\
                        \ which the description configured for the item price is used.\
                        \  \n**Constraints**\n\n* Maximum 500 characters.\n* Whether\
                        \ a description is shown on the invoice at all continues to\
                        \ be controlled by the item price's [show_description_in_invoices](/docs/api/item_prices#show_description_in_invoices)\
                        \ setting. This parameter determines which description is\
                        \ shown, not whether one is shown.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 500
                        example: null
                      example: null
                    proration_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: "**Note**\nApplicable only for item prices with:\n\
                          \n* [item_type](/docs/api/item_prices/item_price-object#item_type)\
                          \ = `addon`.\n* [pricing_model](/docs/api/item_prices/item_price-object#pricing_model)\
                          \ = `per_unit`.\n\nSpecifies how to manage charges or credits\
                          \ for the addon item price for this subscription update\
                          \ estimate. You may use this parameter only if the change\
                          \ to the subscription takes effect [immediately](/docs/api/subscriptions/update-subscription-for-items#change_option).\
                          \  \n**Note** :\nIf you don't provide a value, Chargebee\
                          \ determines the proration logic based on the following\
                          \ precedence: this parameter \\> [prorate](/docs/api/estimates/estimate-object)\n\
                          parameter \\> [item_price.proration_type](/docs/api/item_prices/item_price-object#proration_type)\n\
                          > [site-wide proration](https://www.chargebee.com/docs/2.0/proration.html#proration-for-subscription-change)\n\
                          > setting.\n\n* none - Don't apply any charges or credits\
                          \ for the addon.\n* partial_term - Prorate the charges or\
                          \ credits for the rest of the current term.\n* full_term\
                          \ - Charge the full price of the addon or give the full\
                          \ credit. Don't apply any proration.\n"
                        enum:
                        - full_term
                        - partial_term
                        - none
                        example: null
                      example: null
                  required:
                  - item_price_id
                  example: null
                discounts:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for discounts
                  properties:
                    apply_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The amount on the invoice to which the discount is applied.

                          * invoice_amount -
                            The discount is applied to the invoice `sub_total`
                            .
                          * specific_item_price -
                            The discount is applied to the `invoice.line_item.amount`
                            that corresponds to the item price specified by `item_price_id`
                            .
                        enum:
                        - invoice_amount
                        - specific_item_price
                        example: null
                      example: null
                    duration_type:
                      type: array
                      items:
                        type: string
                        default: forever
                        deprecated: false
                        description: |
                          Specifies the time duration for which this discount is attached to the subscription.

                          * forever -
                            The discount is attached to the subscription and applied on the invoices till it is [explicitly removed](/docs/api/subscriptions/update-subscription-for-items#discounts_operation_type)
                            .
                          * 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 `period`
                            and `period_unit`
                            .
                          * one_time -
                            The discount stays attached to the subscription till it is applied on an invoice **once**.
                            It is removed after that from the subscription.
                        enum:
                        - one_time
                        - forever
                        - limited_period
                        example: null
                      example: null
                    percentage:
                      type: array
                      description: |
                        The percentage of the original amount that should be deducted from it.
                      items:
                        type: number
                        format: double
                        deprecated: false
                        maximum: 100
                        minimum: 0.01
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        The value of the discount. [The format of this value](/docs/api/currencies)
                        depends on the kind of currency.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    period:
                      type: array
                      description: |
                        The duration of time for which the discount is attached to the subscription, in `period_units`.
                        Applicable only when `duration_type`
                        is `limited_period`.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    period_unit:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The unit of time for `period`.
                          Applicable only when `duration_type`
                          is `limited_period`.

                          * day - A period of 24 hours.
                          * week - A period of 7 days.
                          * month - A period of 1 calendar month.
                          * year - A period of 1 calendar year.
                        enum:
                        - day
                        - week
                        - month
                        - year
                        example: null
                      example: null
                    included_in_mrr:
                      type: array
                      description: |
                        The discount is included in MRR calculations for your site. This attribute is only applicable when `duration_type`
                        is `one_time`
                        and when the [feature is enabled](https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation)
                        in Chargebee. Also, If the [site-level setting](https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation)
                        is to exclude one-time discounts from MRR calculations, this value is always returned `false`.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    item_price_id:
                      type: array
                      description: |
                        The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                        in the subscription to which the discount is to be applied. Relevant only when `apply_on`
                        = `specific_item_price`.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Specifies the number of free units provided for the item, without affecting the total quantity sold
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    operation_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The operation to be carried out for the discount.

                          * add - The discount is attached to the subscription.
                          * remove -
                            The discount (given by `discounts[id]`
                            ) is removed from the subscription. Subsequent invoices will no longer have the discount applied. **Tip:**
                            If you want to replace a discount, `remove`
                            it and `add`
                            another in the same API call.
                        enum:
                        - add
                        - remove
                        example: null
                      example: null
                    id:
                      type: array
                      description: |
                        An immutable unique id for the discount. It is always auto-generated.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  required:
                  - duration_type
                  - operation_type
                  example: null
                item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_tiers
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The id of the item price for which the tier price is being overridden.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: |
                        The lowest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The highest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |
                        The overridden price of the tier. The value depends on the [type of currency](/docs/api/estimates)
                        .
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    pricing_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Pricing type for the tier.

                          * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                          * flat_fee -
                            Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                            pricing model, `pricing_type`
                            will be set to `flat_fee`
                            by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                          * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                        enum:
                        - per_unit
                        - flat_fee
                        - package
                        example: null
                      example: null
                    package_size:
                      type: array
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              billing_address:
                style: deepObject
                explode: true
              billing_override:
                style: deepObject
                explode: true
              customer:
                style: deepObject
                explode: true
              discounts:
                style: deepObject
                explode: true
              item_tiers:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              subscription:
                style: deepObject
                explode: true
              subscription_items:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  estimate:
                    $ref: "#/components/schemas/Estimate"
                    description: |
                      Resource object representing estimate
                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:
      tags:
      - customers
      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
        description: "When set to `true`, the `invoice_estimates[]` returned in the\
          \ response includes usage-based line items, if any. These are `invoice_estimates[].line_items[]`\
          \ where [`line_items[].metered`](/docs/api/estimates/estimate-object#invoice_estimate_line_items_metered)\
          \ is `true`.  \n\n**See also:**\n[Pricing for usage-based line items](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/link-pricing).\n\
          \n\n"
        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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
                  estimate:
                    $ref: "#/components/schemas/Estimate"
                    description: |
                      Resource object representing estimate
                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:
      tags:
      - subscriptions
      summary: Regenerate invoice estimate
      description: |
        Regenerates the invoice for the current term of the subscription. The subscription must have `status` as `active` or `non_renewing`. This operation is not allowed when any of the following conditions hold true for the subscription:

        * An invoice exists for the current term and its `status` is not `voided`.
        * There are [unbilled charges](https://www.chargebee.com/docs/unbilled-charges.html) for the current term.
        * The subscription has an [advance invoice](https://www.chargebee.com/docs/advance-invoices.html).

        #### Response

        Returns an `estimate` object with one of the following components depending on the value of `invoice_immediately`.

        * If the value is `true`: an `invoice_estimate` object that corresponds to the regenerated invoice.
        * If the value is `false`: a list of `unbilled_charge_estimate` objects corresponding to all the unbilled charges created for the current term of the subscription.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    Whether the charges should be prorated according to the term specified by `date_from`
                    and `date_to`.
                    Should not be passed without `date_from`
                    and `date_to`
                    .
                  example: null
                invoice_immediately:
                  type: boolean
                  deprecated: false
                  description: |
                    Only applicable when [Consolidated Invoicing](https://www.chargebee.com/docs/consolidated-invoicing.html )
                    is enabled for the customer. Set to `false`
                    to leave the current term charge for the subscription as [unbilled](https://www.chargebee.com/docs/unbilled-charges.html ).
                    Once you have done this for all suitable subscriptions of the customer, call [Create an invoice for unbilled charges](/docs/api/unbilled_charges/create-an-invoice-for-unbilled-charges)
                    to invoice them.
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  estimate:
                    $ref: "#/components/schemas/Estimate"
                    description: |
                      Resource object representing estimate
                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_for_items_estimate:
    post:
      tags:
      - customers
      summary: Estimate for creating a subscription
      description: "Generates an estimate without creating a subscription. This endpoint\
        \ can be called when you want to preview details of a new subscription before\
        \ actually creating one.  \nThe following conditions must be met or **tax\
        \ calculation** is ignored:\n\n* The `taxability` [attribute](/docs/api/customers/customer-object#taxability)\
        \ for the customer is `true`.\n* `shipping_address` is passed when needed\
        \ for tax calculation.\n"
      operationId: estimate_for_creating_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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_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: "If there are charges raised immediately for the subscription,\
                    \ this parameter specifies whether those charges are to be invoiced\
                    \ immediately or added to [unbilled charges](https://www.chargebee.com/docs/unbilled-charges.html).\n\
                    The default value is as per the [site settings](https://www.chargebee.com/docs/unbilled-charges.html#configuration)\n\
                    .  \n**Note:**\n`invoice_immediately`\nonly 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.\n\n.\n"
                  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-item price](/docs/api/item_prices/item_price-object#billing_cycles)
                    is used.
                  minimum: 0
                  example: null
                mandatory_items_to_remove:
                  type: array
                  deprecated: false
                  description: |
                    Item ids of [mandatorily attached addons](/docs/api/attached_items)
                    that are 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
                invoice_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    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.
                    `taxes`
                    and
                    `line_item_taxes`
                    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.
                  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
                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
                    trial_end:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        End of the trial period for the subscription. This overrides the trial period set for the plan-item. The value must be later than `start_date`.
                        Set it to `0`
                        to have no trial period.
                      example: null
                    start_date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        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:

                        * Backdating is enabled for subscription creation operations.
                        * 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.
                        * 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, `start_date` cannot be earlier than 14th February.
                      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: |
                        Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as `billing_cycles`
                        or a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)
                        .
                      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/2.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/2.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/2.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
                  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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ).
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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:
                    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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ).
                      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
                    country:
                      type: string
                      deprecated: false
                      description: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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
                contract_term:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for contract_term
                  properties:
                    action_at_term_end:
                      type: string
                      deprecated: false
                      description: |
                        Action to be taken when the contract term completes.

                        * evergreen - Contract term completes and the subscription renews.
                        * renew -
                          * Contract term completes and a new contract term is started for the number of billing cycles specified in [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).
                          * The `action_at_term_end` for the new contract term is set to `renew`.
                        * cancel - Contract term completes and subscription is canceled.
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      default: 0
                      deprecated: false
                      description: |
                        The number of days before [`contract_end`](/docs/api/contract_terms/contract_term-object#contract_end)
                        , 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.
                      example: null
                  example: null
                billing_override:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for billing_override
                  properties:
                    max_excess_payment_usage:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Maximum amount of [excess payments](/docs/api/customers/customer-object#excess_payments) that can be automatically applied to a single invoice associated with this subscription.

                        **Supported values:**

                        * `-1`: Set to `-1` to reset the subscription-level limit. In this case, the site-level configuration will apply, whether it is configured to Auto Apply or Do Not Auto Apply excess payments.
                        * `0`: Disable auto-application for the subscription. No excess payments will be automatically applied to invoices.
                        * Any positive value: Specifies the maximum amount of excess payments that can be automatically applied to a single invoice for this subscription.
                      minimum: -1
                      example: null
                    max_refundable_credits_usage:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Maximum amount of [refundable credits](/docs/api/customers/customer-object#refundable_credits) that can be automatically applied to a single invoice associated with this subscription.

                        **Supported values:**

                        * `-1`: Set to `-1` to reset the subscription-level limit. In this case, the site-level configuration will apply, whether it is configured to Auto Apply or Do Not Auto Apply refundable credits.
                        * `0`: Disable auto-application for the subscription. No refundable credits will be automatically applied to invoices.
                        * Any positive value: Specifies the maximum amount of refundable credits that can be automatically applied to a single invoice for this subscription.
                      minimum: -1
                      example: null
                  example: null
                subscription_items:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription_items
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The unique identifier of the item price.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        The quantity of the item purchased
                      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 item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        The price/per unit price of the item. When not provided, [the value set](/docs/api/item_prices/item-price-object)
                        for the item price is used. This is only applicable when the `pricing_model`
                        of the item price is `flat_fee`
                        or `per_unit`.
                        Also, it is only allowed when [price overriding](https://www.chargebee.com/docs/price-override.html)
                        is enabled for the site. The value depends on the type of currency. If `changes_scheduled_at`
                        is in the past and a `unit_price`
                        is not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](https://www.chargebee.com/docs/2.0/price-override.html)
                        is enabled for the site, the price or per-unit price of the item can be set here. The [value set for the item price](/docs/api/item_prices/item_price-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/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        For the plan-item price:
                        the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then [the value set](/docs/api/item_prices/item-price-object)
                        for the plan-item price is used.

                        For addon-item prices:
                        If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)
                        are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then [the value set under attached addons](/docs/api/attached_items/attached-item-object)
                        is used. Further, if that value is not provided, then [the value set for the addon-item price](/docs/api/item_prices/item-price-object)
                        is used.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    trial_end:
                      type: array
                      description: |
                        The date/time when the trial period of the item ends. Applies to plan-items and--when [enabled](https://www.chargebee.com/docs/2.0/addons-trial.html)
                        --addon-items as well.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    service_period_days:
                      type: array
                      description: |
                        The service period of the item in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 730
                        minimum: 1
                        example: null
                      example: null
                    charge_on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          When `charge_on_option`
                          option is set to `on_event`
                          , this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.

                          * contract_termination -
                            when a contract term is [terminated](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option)
                            .
                          * subscription_trial_start - the time when the trial period of the subscription begins.
                          * plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                          * subscription_activation -
                            the moment a subscription enters an `active`
                            or `non-renewing`
                            state. Also includes reactivations of canceled subscriptions.
                          * subscription_creation - the time of creation of the subscription.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        Indicates if the charge-item is to be charged only once or each time the `charge_on_event`
                        occurs. This parameter only applies to charge-items.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    description:
                      type: array
                      description: "**Limited availability**\n\nSubscription-level\
                        \ item descriptions are available only on sites where this\
                        \ feature is enabled. Please reach out to the 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\nA description for this item that\
                        \ applies only to this subscription. When set, it is used\
                        \ on the customer-facing invoice instead of the description\
                        \ configured for the item price, and is returned as `entity_description`\
                        \ on the invoice [line item](/docs/api/invoices/invoice-object#invoice_line_items).\
                        \ When not set, the description configured for the item price\
                        \ is used.  \n**Constraints**\n\n* Maximum 500 characters.\n\
                        * Whether a description is shown on the invoice at all continues\
                        \ to be controlled by the item price's [show_description_in_invoices](/docs/api/item_prices#show_description_in_invoices)\
                        \ setting. This parameter determines which description is\
                        \ shown, not whether one is shown.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 500
                        example: null
                      example: null
                    charge_on_option:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates when the charge-item is to be charged. This parameter only applies to charge-items.

                          * on_event -
                            The item is charged at the occurrence of the event specified as `charge_on_event`
                            .
                          * immediately - The item is charged immediately on being added to the subscription.
                        enum:
                        - immediately
                        - on_event
                        example: null
                      example: null
                  required:
                  - item_price_id
                  example: null
                discounts:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for discounts
                  properties:
                    apply_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The amount on the invoice to which the discount is applied.

                          * invoice_amount -
                            The discount is applied to the invoice `sub_total`
                            .
                          * specific_item_price -
                            The discount is applied to the `invoice.line_item.amount`
                            that corresponds to the item price specified by `item_price_id`
                            .
                        enum:
                        - invoice_amount
                        - specific_item_price
                        example: null
                      example: null
                    duration_type:
                      type: array
                      items:
                        type: string
                        default: forever
                        deprecated: false
                        description: |
                          Specifies the time duration for which this discount is attached to the subscription.

                          * forever -
                            The discount is attached to the subscription and applied on the invoices till it is [explicitly removed](/docs/api/subscriptions/update-subscription-for-items#discounts_operation_type)
                            .
                          * 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 `period`
                            and `period_unit`
                            .
                          * one_time -
                            The discount stays attached to the subscription till it is applied on an invoice **once**.
                            It is removed after that from the subscription.
                        enum:
                        - one_time
                        - forever
                        - limited_period
                        example: null
                      example: null
                    percentage:
                      type: array
                      description: |
                        The percentage of the original amount that should be deducted from it.
                      items:
                        type: number
                        format: double
                        deprecated: false
                        maximum: 100
                        minimum: 0.01
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        The value of the discount. [The format of this value](/docs/api/currencies)
                        depends on the kind of currency.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    period:
                      type: array
                      description: |
                        The duration of time for which the discount is attached to the subscription, in `period_units`.
                        Applicable only when `duration_type`
                        is `limited_period`.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    period_unit:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The unit of time for `period`.
                          Applicable only when `duration_type`
                          is `limited_period`.

                          * day - A period of 24 hours.
                          * week - A period of 7 days.
                          * month - A period of 1 calendar month.
                          * year - A period of 1 calendar year.
                        enum:
                        - day
                        - week
                        - month
                        - year
                        example: null
                      example: null
                    included_in_mrr:
                      type: array
                      description: |
                        The discount is included in MRR calculations for your site. This attribute is only applicable when `duration_type`
                        is `one_time`
                        and when the [feature is enabled](https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation)
                        in Chargebee. Also, If the [site-level setting](https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation)
                        is to exclude one-time discounts from MRR calculations, this value is always returned `false`.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    item_price_id:
                      type: array
                      description: |
                        The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                        in the subscription to which the discount is to be applied. Relevant only when `apply_on`
                        = `specific_item_price`.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Specifies the number of free units provided for the item, without affecting the total quantity sold
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                  required:
                  - duration_type
                  example: null
                item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_tiers
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The id of the item price for which the tier price is being overridden.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: |
                        The lowest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The highest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |
                        The overridden price of the tier. The value depends on the [type of currency](/docs/api/estimates)
                        .
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    pricing_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Pricing type for the tier.

                          * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                          * flat_fee -
                            Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                            pricing model, `pricing_type`
                            will be set to `flat_fee`
                            by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                          * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                        enum:
                        - per_unit
                        - flat_fee
                        - package
                        example: null
                      example: null
                    package_size:
                      type: array
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              billing_address:
                style: deepObject
                explode: true
              billing_override:
                style: deepObject
                explode: true
              contract_term:
                style: deepObject
                explode: true
              discounts:
                style: deepObject
                explode: true
              item_tiers:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              subscription:
                style: deepObject
                explode: true
              subscription_items:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  estimate:
                    $ref: "#/components/schemas/Estimate"
                    description: |
                      Resource object representing estimate
                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:
      tags:
      - subscriptions
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: "If there are charges raised immediately for the subscription,\
                    \ this parameter specifies whether those charges are to be invoiced\
                    \ immediately or added to [unbilled charges](https://www.chargebee.com/docs/unbilled-charges.html).\n\
                    The default value is as per the [site settings](https://www.chargebee.com/docs/unbilled-charges.html#configuration)\n\
                    .  \n**Note:**\n`invoice_immediately`\nonly 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.\n\n.\n"
                  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: |
                      Resource object representing estimate
                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:
      tags:
      - subscriptions
      summary: Pause subscription estimate
      description: |
        This API provides an estimate of the details pertaining to the [pause_subscription](/docs/api/subscriptions/pause-a-subscription) operation. It returns attributes such as [pause_date](/docs/api/estimates/estimate-object#subscription_estimate_pause_date) and [resume_date](/docs/api/estimates/estimate-object#subscription_estimate_resume_date). This is similar to the [Pause a subscription](/docs/api/subscriptions/pause-a-subscription) API with the exception that the subscription is not paused. 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 are generated immediately. This is not present if no immediate invoices are generated for this operation.
        * **estimate.credit_note_estimates\[\]** has details of the credit notes that are generated during this operation. This list is empty if no credit notes are generated.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    List of options to pause the subscription.

                    * billing_cycles - Pause at the end of the current term, and resume automatically after the number of billing cycles you specify in [skip_billing_cycles](/docs/api/estimates/pause-subscription-estimate#subscription_skip_billing_cycles)
                    * immediately - Pause immediately
                    * end_of_term - Pause at the end of current term
                    * specific_date - Pause on a specific date
                  enum:
                  - immediately
                  - end_of_term
                  - specific_date
                  - billing_cycles
                  example: null
                unbilled_charges_handling:
                  type: string
                  deprecated: false
                  description: |
                    Applicable when unbilled charges are present for the subscription and [pause_option](/docs/api/estimates/pause-subscription-estimate#pause_option) is set as `immediately`. **Note:** On the invoice raised, an automatic charge is attempted on the payment method available, if customer's auto-collection property is set to `on`.

                    * invoice -
                      Invoice charges
                      If `invoice` 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.
                    * no_action -
                      Retain as unbilled
                      If `no_action` is chosen, charges are added to the resumption invoice.
                  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: |
                        When a pause has been scheduled, it is the date/time of scheduled pause. When the subscription is in the `paused`
                        state, it is the date/time when the subscription was paused.
                      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: |
                      Resource object representing estimate
                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:
      tags:
      - subscriptions
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    * For `schedule_type = immediate`: the number of future billing cycles to be invoiced in advance. The invoicing is done for the [`remaining_billing_cycles`](/docs/api/subscriptions/subscription-object#remaining_billing_cycles) of the subscription if that is less than `terms_to_charge`.
                    * For `schedule_type = fixed_intervals`: The number of future billing cycles in one [interval](/docs/api/advance_invoice_schedules). The schedule is created such that the total number of billing cycles in the schedule does not exceed the [remaining_billing_cycles](/docs/api/subscriptions/subscription-object#remaining_billing_cycles) of the subscription. .
                  minimum: 1
                  example: null
                invoice_immediately:
                  type: boolean
                  deprecated: false
                  description: |
                    Whether the charge should be invoiced immediately or added to [`unbilled_charges`](/docs/api/unbilled_charges).
                    Applicable only when [`schedule_type`](/docs/api/subscriptions/charge-future-renewals#schedule_type)
                    is `immediate`
                    .
                  example: null
                schedule_type:
                  type: string
                  deprecated: false
                  description: |
                    The type of advance invoice or advance invoicing schedule.

                    * immediate -
                      Charge immediately for the number of billing cycles specified by [`terms_to_charge`](/docs/api/subscriptions/charge-future-renewals#terms_to_charge)
                      .
                    * 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:
                  - 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: |
                        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 [`remaining_billing_cycles`](/docs/api/subscriptions/subscription-object#remaining_billing_cycles)
                        of the subscription. This parameter is applicable only when [`fixed_interval_schedule[end_schedule_on]`](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#fixed_interval_schedule_end_schedule_on)
                        = `after_number_of_intervals`
                      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: |
                        Specifies when the schedule should end.

                        * after_number_of_intervals - Advance invoices are generated a `specified number of times`
                        * subscription_end - Advance invoices are generated for as long as the subscription is active.
                        * specific_date -
                          End the advance invoicing schedule on a `specific date`
                          .
                      enum:
                      - after_number_of_intervals
                      - specific_date
                      - subscription_end
                      example: null
                    end_date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        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 [`fixed_interval_schedule[end_schedule_on]`](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#fixed_interval_schedule_end_schedule_on)
                        = `specific_date`
                        .
                      example: null
                  example: null
                specific_dates_schedule:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for specific_dates_schedule
                  properties:
                    terms_to_charge:
                      type: array
                      description: |
                        The number of billing cycles to charge for, on the date specified. Applicable only when [`schedule_type`](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#schedule_type)
                        is specific_dates.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    date:
                      type: array
                      description: |
                        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 [`schedule_type`](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#schedule_type)
                        is `specific_dates`
                        .
                      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: |
                      Resource object representing estimate
                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_quote_for_items:
    post:
      tags:
      - customers
      summary: Create a quote for subscription creation
      description: |
        Create a quote for new subscription line items of a customer.
      operationId: create_a_quote_for_a_new_subscription_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
                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: |
                    The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles [set for the plan-item price](/docs/api/item_prices/item_price-object#billing_cycles)
                    is used.
                  minimum: 0
                  example: null
                mandatory_items_to_remove:
                  type: array
                  deprecated: false
                  description: |
                    Item ids of [mandatorily attached addons](/docs/api/attached_items)
                    that are 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: "The list of [IDs](/docs/api/coupons/coupon-object#id)\
                    \ of the coupons to be applied. [Coupon codes](/docs/api/coupon_codes)\
                    \ are also supported.  \n**Note**\n\nNot applicable when Chargebee\
                    \ CPQ is enabled. Use `coupons[]` array instead.\n"
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                billing_start_option:
                  type: string
                  default: on_specific_date
                  deprecated: false
                  description: "When the quote is converted, this attribute determines\
                    \ the date/time as of when the subscription start is to be carried\
                    \ out.  \n**Note**\n\nThe parameter applies only when Chargebee\
                    \ CPQ is enabled. To request access, 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\
                    \n* on_specific_date - Upon quote conversion, the subscription\
                    \ is scheduled to start on the specified date.\n* immediately\
                    \ - The subscription starts immediately upon conversion of the\
                    \ quote to a subscription.\n"
                  enum:
                  - immediately
                  - on_specific_date
                  example: null
                net_term_days:
                  type: integer
                  format: int32
                  deprecated: false
                  description: "The number of days from [`invoice.date`](/docs/api/invoices/invoice-object#date)\
                    \ until payment for the invoice is due.  \n**Note**\n\nThe parameter\
                    \ applies only when Chargebee CPQ is enabled. To request access,\
                    \ 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"
                  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
                    po_number:
                      type: string
                      deprecated: false
                      description: |
                        Purchase order number for this subscription.
                      maxLength: 100
                      example: null
                    trial_end:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        End of the trial period for the subscription. This overrides the trial period set for the plan-item. The value must be later than `start_date`.
                        Set it to `0`
                        to have no trial period.
                      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 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:

                        * Backdating is enabled for subscription creation operations.
                        * 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.
                        * 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, `subscription[start_date]` cannot be earlier than 14th February.
                      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: |
                        Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as `billing_cycles`
                        or a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)
                        .
                      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 extended free of charge. The value is\
                        \ expressed in the time unit specified by `free_period_unit`.\
                        \ For example, `3` with `free_period_unit` = `month` adds\
                        \ 3 free months to the first term of the subscription.  \n\
                        \n**Prerequisite**\nCan be used only when Chargebee CPQ is\
                        \ enabled. To request access, [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\
                        \n\n"
                      minimum: 1
                      example: null
                    free_period_unit:
                      type: string
                      deprecated: false
                      description: "The time unit for `free_period`.  \n\n**Prerequisite**\n\
                        Can be used only when Chargebee CPQ is enabled. To request\
                        \ access, [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\
                        \n**Constraint**\nMust be equal to or lower than the [`period_unit`](/docs/api/item_prices#period_unit)\
                        \ of the plan [item price](/docs/api/quotes/create-a-quote-for-a-new-subscription-items#subscription_items_item_price_id)\
                        \ of the subscription.\n\n* year - Charge based on year(s)\n\
                        * day - Charge based on day(s)\n* month - Charge based on\
                        \ month(s)\n* week - Charge based on week(s)\n"
                      enum:
                      - day
                      - week
                      - month
                      - year
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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: |
                        Action to be taken when the contract term completes.

                        * evergreen - Contract term completes and the subscription renews.
                        * renew -
                          * Contract term completes and a new contract term is started for the number of billing cycles specified in [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).
                          * The `action_at_term_end` for the new contract term is set to `renew`.
                        * cancel - Contract term completes and subscription is canceled.
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      default: 0
                      deprecated: false
                      description: |
                        The number of days before [`contract_end`](/docs/api/contract_terms/contract_term-object#contract_end)
                        , 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.
                      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.  \n**Note**\n\
                        \nThe parameter `billing_address` and all its sub-parameters\
                        \ apply only when Chargebee CPQ is enabled. To request access,\
                        \ 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"
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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
                    country:
                      type: string
                      deprecated: false
                      description: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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
                subscription_items:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription_items
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The unique identifier of the item price.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        The quantity of the item purchased
                      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 item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        The price/per unit price of the item. When not provided, [the value set](/docs/api/item_prices/item-price-object)
                        for the item price is used. This is only applicable when the `pricing_model`
                        of the item price is `flat_fee`
                        or `per_unit`.
                        Also, it is only allowed when [price overriding](https://www.chargebee.com/docs/price-override.html)
                        is enabled for the site. The value depends on the type of currency. If `changes_scheduled_at`
                        is in the past and a `unit_price`
                        is not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](https://www.chargebee.com/docs/2.0/price-override.html)
                        is enabled for the site, the price or per-unit price of the item can be set here. The [value set for the item price](/docs/api/item_prices/item_price-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/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        For the plan-item price:
                        the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then [the value set](/docs/api/item_prices/item-price-object)
                        for the plan-item price is used.

                        For addon-item prices:
                        If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)
                        are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then [the value set under attached addons](/docs/api/attached_items/attached-item-object)
                        is used. Further, if that value is not provided, then [the value set for the addon-item price](/docs/api/item_prices/item-price-object)
                        is used.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    trial_end:
                      type: array
                      description: |
                        The date/time when the trial period of the item ends. Applies to plan-items and--when [enabled](https://www.chargebee.com/docs/2.0/addons-trial.html)
                        --addon-items as well.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    service_period_days:
                      type: array
                      description: |
                        The service period of the item in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 730
                        minimum: 1
                        example: null
                      example: null
                    charge_on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          When `charge_on_option`
                          option is set to `on_event`
                          , this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.

                          * contract_termination -
                            when a contract term is [terminated](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option)
                            .
                          * subscription_trial_start - the time when the trial period of the subscription begins.
                          * plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                          * subscription_activation -
                            the moment a subscription enters an `active`
                            or `non-renewing`
                            state. Also includes reactivations of canceled subscriptions.
                          * subscription_creation - the time of creation of the subscription.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        Indicates if the charge-item is to be charged only once or each time the `charge_on_event`
                        occurs. This parameter only applies to charge-items.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    charge_on_option:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates when the charge-item is to be charged. This parameter only applies to charge-items.

                          * on_event -
                            The item is charged at the occurrence of the event specified as `charge_on_event`
                            .
                          * immediately - The item is charged immediately on being added to the subscription.
                        enum:
                        - immediately
                        - on_event
                        example: null
                      example: null
                    start_date:
                      type: array
                      description: "Specifies the start date for the item price in\
                        \ the subscription. The period of the item price, determined\
                        \ by the `start_date` and `end_date`, specifies the [ramp](/docs/api/quoted_ramps)\
                        \ it belongs to.  \n**Note**\n\nThe parameter applies only\
                        \ when Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    end_date:
                      type: array
                      description: "Specifies the end date for the item price in the\
                        \ subscription. The period of the item price, determined by\
                        \ the `start_date` and `end_date`, specifies the [ramp](/docs/api/quoted_ramps)\
                        \ it belongs to.  \n**Note**\n\nThe parameter applies only\
                        \ when Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    description:
                      type: array
                      description: ""
                      items:
                        type: string
                        deprecated: false
                        maxLength: 2000
                        example: null
                      example: null
                    ramp_tier_id:
                      type: array
                      description: "The index or identifier of the [ramp](/docs/api/quoted_ramps)\
                        \ to which the item price belongs. Use this index to map `item_tier`\
                        \ values to the correct ramp, as the target `item_price` of\
                        \ an `item_tier` may be part of multiple ramps.  \n**Note**\n\
                        \nThe parameter applies only when Chargebee CPQ is enabled.\
                        \ To request access, 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"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 105
                        example: null
                      example: null
                  required:
                  - item_price_id
                  example: null
                discounts:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for discounts
                  properties:
                    apply_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The amount on the quote to which the discount is applied.

                          * invoice_amount -
                            The discount is applied to the invoice `sub_total`
                            .
                          * specific_item_price -
                            The discount is applied to the `invoice.line_item.amount`
                            that corresponds to the item price specified by `item_price_id`
                            .
                        enum:
                        - invoice_amount
                        - specific_item_price
                        example: null
                      example: null
                    duration_type:
                      type: array
                      items:
                        type: string
                        default: forever
                        deprecated: false
                        description: |
                          Specifies the time duration for which this discount is attached to the subscription.

                          * forever -
                            The discount is attached to the subscription and applied on the invoices till it is [explicitly removed](/docs/api/subscriptions/update-subscription-for-items#discounts_operation_type)
                            .
                          * 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 `period`
                            and `period_unit`
                            .
                          * one_time -
                            The discount stays attached to the subscription till it is applied on an invoice **once**.
                            It is removed after that from the subscription.
                        enum:
                        - one_time
                        - forever
                        - limited_period
                        example: null
                      example: null
                    percentage:
                      type: array
                      description: |
                        The percentage of the original amount that should be deducted from it.
                      items:
                        type: number
                        format: double
                        deprecated: false
                        maximum: 100
                        minimum: 0.01
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        The value of the discount. [The format of this value](/docs/api/currencies)
                        depends on the kind of currency.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    period:
                      type: array
                      description: |
                        The duration of time for which the discount is attached to the subscription, in `period_units`.
                        Applicable only when `duration_type`
                        is `limited_period`.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    period_unit:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The unit of time for `period`.
                          Applicable only when `duration_type`
                          is `limited_period`.

                          * day - A period of 24 hours.
                          * week - A period of 7 days.
                          * month - A period of 1 calendar month.
                          * year - A period of 1 calendar year.
                        enum:
                        - day
                        - week
                        - month
                        - year
                        example: null
                      example: null
                    included_in_mrr:
                      type: array
                      description: |
                        The discount is included in MRR calculations for your site. This attribute is only applicable when `duration_type`
                        is `one_time`
                        and when the [feature is enabled](https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation)
                        in Chargebee. Also, If the [site-level setting](https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation)
                        is to exclude one-time discounts from MRR calculations, this value is always returned `false`.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    item_price_id:
                      type: array
                      description: |
                        The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                        in the subscription to which the discount is to be applied. Relevant only when `apply_on`
                        = `specific_item_price`.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Specifies the number of free units provided for the item, without affecting the total quantity sold
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    start_date:
                      type: array
                      description: "Specifies the start date for the discount. The\
                        \ period of the discount, as specified by the `start_date`\
                        \ and `end_date` determines the [ramp(s)](/docs/api/quoted_ramps)\
                        \ it will be part of.  \n**Note**\n\nThe parameter applies\
                        \ only when Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    end_date:
                      type: array
                      description: "Specifies the end date for the discount. The period\
                        \ of the discount, as specified by the `start_date` and `end_date`\
                        \ determines the [ramp(s)](/docs/api/quoted_ramps) it will\
                        \ be part of.  \n**Note**\n\nThe parameter applies only when\
                        \ Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  required:
                  - duration_type
                  example: null
                item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_tiers
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The id of the item price for which the tier price is being overridden.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: |
                        The lowest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The highest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |
                        The overridden price of the tier. The value depends on the [type of currency](/docs/api/quotes)
                        .
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    pricing_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Pricing type for the tier.

                          * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                          * flat_fee -
                            Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                            pricing model, `pricing_type`
                            will be set to `flat_fee`
                            by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                          * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                        enum:
                        - per_unit
                        - flat_fee
                        - package
                        example: null
                      example: null
                    package_size:
                      type: array
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ramp_tier_id:
                      type: array
                      description: "The index or identifier of the [ramp](/docs/api/quoted_ramps)\
                        \ to which this tier information belongs. This must be a value\
                        \ from the `subscription_items[ramp_tier_id][i]`. Since an\
                        \ item price can be part of multiple subscriptions ramps,\
                        \ this group ID specifies the ramp to which this tier information\
                        \ belongs.  \n**Note**\n\nThe parameter applies only when\
                        \ Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 105
                        example: null
                      example: null
                  example: null
                coupons:
                  type: object
                  deprecated: false
                  description: ""
                  properties:
                    id:
                      type: array
                      description: "The [ID](/docs/api/coupons/coupon-object#id) of\
                        \ the coupon to be applied. [Coupon codes](/docs/api/coupon_codes)\
                        \ are not supported.  \n**Note**\n\nThe parameter applies\
                        \ only when Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    start_date:
                      type: array
                      description: "Specifies the start date for the coupon. The period\
                        \ of the coupon, as specified by the `start_date` and `end_date`\
                        \ determines the [ramp(s)](/docs/api/quoted_ramps) it will\
                        \ be part of.  \n**Note**\n\nThe parameter applies only when\
                        \ Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    end_date:
                      type: array
                      description: "Specifies the end date for the coupon. The period\
                        \ of the coupon, as specified by the `start_date` and `end_date`\
                        \ determines the [ramp(s)](/docs/api/quoted_ramps) it will\
                        \ be part of.  \n**Note**\n\nThe parameter applies only when\
                        \ Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
                entitlement_overrides:
                  type: object
                  deprecated: false
                  description: |
                    The set of entitlement overrides to apply on this quote. Each entry targets a feature for an entity on the quote. Overrides are always upserted.
                  properties:
                    feature_id:
                      type: array
                      description: |
                        The `id` of the `feature` for which the entitlement override is being set.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    entity_id:
                      type: array
                      description: |
                        The `id` of the entity on the quote (for example, a `plan_price`, `addon_price`, or `charge_price` handle from the quote context) whose entitlement is being overridden.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    entity_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The type of the entity on the quote for which the entitlement override is being set.

                          * plan_price - Indicates that the entity is an `item_price` with [`item_type`](/docs/api/item_prices/item-price-object#item_type) set to `plan`.
                          * charge_price - Indicates that the entity is an `item_price` with [`item_type`](/docs/api/item_prices/item-price-object#item_type) set to `charge`.
                          * addon_price - Indicates that the entity is an `item_price` with [`item_type`](/docs/api/item_prices/item-price-object#item_type) set to `addon`.
                        enum:
                        - plan_price
                        - addon_price
                        - charge_price
                        example: null
                      example: null
                    value:
                      type: array
                      description: |+
                        The level of entitlement that the item has towards the feature. The possible values depend on the value of `feature.type`
                        :

                        * When `feature.type` is `custom`: The value can be any one of `levels[].value`.

                        * When `feature.type` is `switch`: This value is `true` when the feature is available; it is `false` when the feature is unavailable.

                        * When `feature.type` is `quantity`:

                        * When `levels[].is_unlimited` is not `true`: The value can be any one of `levels[].value`.

                        * When `levels[].is_unlimited` is `true`: The value can also be any one of `levels[].value` or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.

                        * When `feature.type` is `range`:

                        * When `levels[].is_unlimited` is not `true`: The value can be any whole number between `levels[0].value` and `levels[1].value` (inclusive).

                        * When `levels[].is_unlimited` is `true`: The value can be any whole number equal to or greater than `levels[0].value` or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.

                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    is_enabled:
                      type: array
                      description: |
                        Specifies whether the entitlement for the feature is enabled (`true`) or disabled (`false`) for the entity on the quote.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    start_date:
                      type: array
                      description: |
                        Start date (UTC timestamp) of the entitlement override for the item on the quote. Used with `end_date` for ramp-scoped entitlements.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    end_date:
                      type: array
                      description: |
                        End date (UTC timestamp) of the entitlement override for the item on the quote. Used with `start_date` for ramp-scoped entitlements.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              billing_address:
                style: deepObject
                explode: true
              contract_term:
                style: deepObject
                explode: true
              coupons:
                style: deepObject
                explode: true
              discounts:
                style: deepObject
                explode: true
              entitlement_overrides:
                style: deepObject
                explode: true
              item_tiers:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              subscription:
                style: deepObject
                explode: true
              subscription_items:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  quote:
                    $ref: "#/components/schemas/Quote"
                    description: |
                      Resource object representing quote
                  quoted_subscription:
                    $ref: "#/components/schemas/QuotedSubscription"
                    description: |
                      Resource object representing quoted_subscription
                  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}:
    get:
      tags:
      - quotes
      summary: Retrieve a quote
      description: |
        Retrieves the quotes identified by the 'number' specified in the url.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  quote:
                    $ref: "#/components/schemas/Quote"
                    description: |
                      Resource object representing quote
                  quoted_subscription:
                    $ref: "#/components/schemas/QuotedSubscription"
                    description: |
                      Resource object representing quoted_subscription
                  quoted_charge:
                    $ref: "#/components/schemas/QuotedCharge"
                    description: |
                      Resource object representing quoted_charge
                  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}/update_status:
    post:
      tags:
      - quotes
      summary: Update quote status
      description: |
        Updates the status of the quote.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: "The status to which the quote should be updated.\n\
                    \n* accepted - The customer has accepted the quote.\n* closed\
                    \ -\n  The quote has been marked as closed.  \n  **Note**\n\n\
                    \  Not applicable when Chargebee CPQ is enabled.\n* declined -\
                    \ The customer declined/rejected the quote.\n* proposed -\n  The\
                    \ quote has been shared with the customer via email or e-signature\
                    \ and is awaiting their response.  \n  **Note**\n\n  Applicable\
                    \ only when Chargebee CPQ is enabled. To request access, 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\
                    * voided -\n  The quote has been invalidated and can no longer\
                    \ be acted upon.  \n  **Note**\n\n  Applicable only when Chargebee\
                    \ CPQ is enabled. To request access, 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"
                  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: |
                      Resource object representing quote
                  quoted_subscription:
                    $ref: "#/components/schemas/QuotedSubscription"
                    description: |
                      Resource object representing quoted_subscription
                  quoted_charge:
                    $ref: "#/components/schemas/QuotedCharge"
                    description: |
                      Resource object representing quoted_charge
                  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}/extend_expiry_date:
    post:
      tags:
      - quotes
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing quote
                  quoted_subscription:
                    $ref: "#/components/schemas/QuotedSubscription"
                    description: |
                      Resource object representing quoted_subscription
                  quoted_charge:
                    $ref: "#/components/schemas/QuotedCharge"
                    description: |
                      Resource object representing quoted_charge
                  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_update_subscription_quote_for_items:
    post:
      tags:
      - quotes
      summary: Edit a quote for subscription update
      description: "Edits a quote for updating a subscription.  \n\n### Impacts\n\n\
        **#### Quote and related resources**  \nIf the quote is for a scheduled change,\
        \ then the following resources are updated:\n\n* When [Ramps](ramps) are disabled,\
        \ the `quote` and the [`quoted_subscription`](quoted_subscriptions) are updated.\n\
        * When [Ramps](ramps) are enabled with compatibility mode, the `quote`, the\
        \ [`quoted_ramp`](quoted_ramps), and the [`quoted_subscription`](quoted_subscriptions)\
        \ are updated.\n\nFor more details, see [Ramps API compatibility mode](subscriptions#ramps-compat-mode).\n"
      operationId: edit_update_subscription_quote_for_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
              additionalProperties: true
              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
                mandatory_items_to_remove:
                  type: array
                  deprecated: false
                  description: |
                    Item ids of [mandatorily attached addons](/docs/api/attached_items)
                    that are to be removed from the subscription.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                replace_items_list:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    If `true`
                    then the existing `subscription_items`
                    list for the subscription is replaced by the one provided. If `false`
                    then the provided `subscription_items`
                    list gets added to the existing list.
                  example: null
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Billing cycles set for plan-item price is used by default.
                  minimum: 0
                  example: null
                terms_to_charge:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of subscription billing cycles to [invoice in advance](https://www.chargebee.com/docs/advance-invoices.html).
                    If a new term is started for the subscription due to this API call, then `terms_to_charge`
                    is inclusive of this new term. See description for the `force_term_reset`
                    parameter to learn more about when a subscription term is reset.
                  minimum: 1
                  example: null
                reactivate_from:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    If the subscription `status`
                    is `cancelled`
                    and it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.
                    **Note:**
                    It is recommended not to pass this parameter along with `changed_scheduled_at`.
                    `reactivate_from`
                    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:

                    * Backdating must be enabled for subscription reactivation operations.
                    * 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.
                    * The date is on or after the last date/time any of the product catalog items of the subscription were changed.
                    * 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, `changes_scheduled_at` cannot be earlier than 14th February. .
                  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: "The list of [IDs](/docs/api/coupons/coupon-object#id)\
                    \ of the coupons to be applied. [Coupon codes](/docs/api/coupon_codes)\
                    \ are also supported.  \n**Note**\n\nNot applicable when Chargebee\
                    \ CPQ is enabled. Use `coupons[]` array instead.\n"
                  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: |
                    When the quote is converted, this attribute determines the date/time as of when the subscription change is to be carried out.

                    * specific_date -
                      The change is carried out as of the date specified under `changes_scheduled_at`
                      .
                    * immediately - The change is carried out immediately.
                  enum:
                  - immediately
                  - specific_date
                  example: null
                changes_scheduled_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: "When `change_option` is set to `specific_date`, then\
                    \ set the date-time at which the subscription change is to happen\
                    \ or has happened.  \n**Constraints**\n\n* Do not pass this parameter\
                    \ along with `reactivate_from`.\n* The `changes_scheduled_at`\
                    \ parameter does not apply to `auto_collection`, `shipping_address`,\
                    \ and `po_number`; these parameters take effect **immediately**\
                    \ when scheduling a subscription update.  \n**Backdated changes**\n\
                    \n`changes_scheduled_at`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:\n\n* Backdating must be\
                    \ [enabled](https://www.chargebee.com/docs/billing/2.0/subscriptions/backdating#configuring-backdated-subscription-actions-and-invoicing)\
                    \ for subscription change operations.\n* Only the following changes\
                    \ can be backdated:\n  * Changes in the recurring items or their\
                    \ prices.\n  * Addition of non-recurring items.\n* Subscription\
                    \ `status` is `active`, `cancelled`, or `non_renewing`.\n* 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.\n* The date is on or after `current_term_start`.\n\
                    * The date is on or after the last date/time any of the following\
                    \ changes were made:\n  * Changes in the recurring items or their\
                    \ prices.\n  * Addition of non-recurring items.\n"
                  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
                net_term_days:
                  type: integer
                  format: int32
                  deprecated: false
                  description: "The number of days from [`invoice.date`](/docs/api/invoices/invoice-object#date)\
                    \ until payment for the invoice is due.  \n**Note**\nThe parameter\
                    \ applies only when Chargebee CPQ is enabled. To request access,\
                    \ 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"
                  example: null
                subscription:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    Parameters for subscription
                  properties:
                    start_date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The new start date of a `future`
                        subscription. Applicable only for `future`
                        subscriptions.
                      example: null
                    trial_end:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The time at which the trial has ended or will end for the subscription. This is only allowed when the subscription `status`
                        is `future`
                        , `in_trial`
                        , or `cancelled`.
                        Also, the value must not be earlier than `changes_scheduled_at`
                        or `start_date`.
                        **Note** :
                        This parameter can be backdated (set to a value in the past) only when the subscription is in `cancelled`
                        or `in_trial`
                        `status`.
                        Do this to keep a record of when the trial ended in case it ended at some point in the past. When `trial_end`
                        is backdated, the subscription immediately goes into `active`
                        or `non_renewing`
                        status.
                      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: |
                        Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as `billing_cycles`
                        or a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)
                        .
                      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.  \n**Note**\n\
                        The parameter `billing_address` and all its sub-parameters\
                        \ apply only when Chargebee CPQ is enabled. To request access,\
                        \ 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"
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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: |
                        An overridden value for the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number).
                        Only applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)

                        `country`
                        as `XI`
                        (which is **United Kingdom - Northern Ireland**
                        ).

                        When you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)
                        in 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)
                        the Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)

                        `country`
                        as `XI`.
                        That's the code for **United Kingdom - Northern Ireland** .
                        The first two characters of the VAT number in such a case is
                        `XI`
                        by default. However, if the VAT number was registered in UK, the value should be `GB`.
                        Set
                        `vat_number_prefix`
                        to `GB`
                        for such cases.
                      maxLength: 10
                      example: null
                    registered_for_gst:
                      type: boolean
                      deprecated: false
                      description: |
                        Confirms that a customer is registered under GST. If set to `true`
                        then the [Reverse Charge Mechanism](https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism)
                        is applicable. This field is applicable only when Australian GST is configured for your site.
                      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: |
                        Action to be taken when the contract term completes.

                        * evergreen - Contract term completes and the subscription renews.
                        * renew -
                          * Contract term completes and a new contract term is started for the number of billing cycles specified in [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).
                          * The `action_at_term_end` for the new contract term is set to `renew`.
                        * renew_once -
                          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 [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).

                          * The `action_at_term_end` for the new contract term is set to `cancel`.
                        * cancel - Contract term completes and subscription is canceled.
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      - renew_once
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        The number of days before [`contract_end`](/docs/api/contract_terms/contract_term-object#contract_end)
                        , 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.
                      example: null
                  example: null
                subscription_items:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription_items
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The unique identifier of the item price.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        The quantity of the item purchased
                      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 item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        The price/per unit price of the item. When not provided, [the value set](/docs/api/item_prices/item-price-object)
                        for the item price is used. This is only applicable when the `pricing_model`
                        of the item price is `flat_fee`
                        or `per_unit`.
                        Also, it is only allowed when [price overriding](https://www.chargebee.com/docs/price-override.html)
                        is enabled for the site. The value depends on the type of currency. If `changes_scheduled_at`
                        is in the past and a `unit_price`
                        is not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](https://www.chargebee.com/docs/price-override.html)
                        is enabled for the site, the price or per-unit price of the item can be set here. The [value set for the item price](/docs/api/item_prices/item_price-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/getting-started)
                        is enabled. If `changes_scheduled_at`
                        is in the past and a `unit_price_in_decimal`
                        is not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        For the plan-item price:
                        the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then [the value set](/docs/api/item_prices/item-price-object)
                        for the plan-item price is used.

                        For addon-item prices:
                        If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)
                        are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then [the value set under attached addons](/docs/api/attached_items/attached-item-object)
                        is used. Further, if that value is not provided, then [the value set for the addon-item price](/docs/api/item_prices/item-price-object)
                        is used.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    trial_end:
                      type: array
                      description: |
                        The date/time when the trial period of the item ends. Applies to plan-items and--when [enabled](https://www.chargebee.com/docs/2.0/addons-trial.html)
                        --addon-items as well.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    service_period_days:
                      type: array
                      description: |
                        The service period of the item in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 730
                        minimum: 1
                        example: null
                      example: null
                    charge_on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          When `charge_on_option`
                          option is set to `on_event`
                          , this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.

                          * contract_termination -
                            when a contract term is [terminated](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option)
                            .
                          * subscription_trial_start - the time when the trial period of the subscription begins.
                          * plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                          * subscription_activation -
                            the moment a subscription enters an `active`
                            or `non-renewing`
                            state. Also includes reactivations of canceled subscriptions.
                          * subscription_creation - the time of creation of the subscription.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        Indicates if the charge-item is to be charged only once or each time the `charge_on_event`
                        occurs. This parameter only applies to charge-items.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    charge_on_option:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates when the charge-item is to be charged. This parameter only applies to charge-items.

                          * on_event -
                            The item is charged at the occurrence of the event specified as `charge_on_event`
                            .
                          * immediately - The item is charged immediately on being added to the subscription.
                        enum:
                        - immediately
                        - on_event
                        example: null
                      example: null
                    start_date:
                      type: array
                      description: "Specifies the start date for the item price in\
                        \ the subscription. The period of the item price, determined\
                        \ by the `start_date` and `end_date`, specifies the [ramp](/docs/api/quoted_ramps)\
                        \ it belongs to.  \n**Note**\n\nThe parameter applies only\
                        \ when Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    end_date:
                      type: array
                      description: "Specifies the end date for the item price in the\
                        \ subscription. The period of the item price, determined by\
                        \ the `start_date` and `end_date`, specifies the [ramp](/docs/api/quoted_ramps)\
                        \ it belongs to.  \n**Note**\n\nThe parameter applies only\
                        \ when Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    description:
                      type: array
                      description: ""
                      items:
                        type: string
                        deprecated: false
                        maxLength: 2000
                        example: null
                      example: null
                    ramp_tier_id:
                      type: array
                      description: "The index or identifier of the [ramp](/docs/api/quoted_ramps)\
                        \ to which the item price belongs. Use this index to map `item_tier`\
                        \ values to the correct ramp, as the target `item_price` of\
                        \ an `item_tier` may be part of multiple ramps.  \n**Note**\n\
                        \nThe parameter applies only when Chargebee CPQ is enabled.\
                        \ To request access, 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"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 105
                        example: null
                      example: null
                  required:
                  - item_price_id
                  example: null
                discounts:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for discounts
                  properties:
                    apply_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The amount on the quote to which the discount is applied.

                          * invoice_amount -
                            The discount is applied to the invoice `sub_total`
                            .
                          * specific_item_price -
                            The discount is applied to the `invoice.line_item.amount`
                            that corresponds to the item price specified by `item_price_id`
                            .
                        enum:
                        - invoice_amount
                        - specific_item_price
                        example: null
                      example: null
                    duration_type:
                      type: array
                      items:
                        type: string
                        default: forever
                        deprecated: false
                        description: |
                          Specifies the time duration for which this discount is attached to the subscription.

                          * forever -
                            The discount is attached to the subscription and applied on the invoices till it is [explicitly removed](/docs/api/subscriptions/update-subscription-for-items#discounts_operation_type)
                            .
                          * 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 `period`
                            and `period_unit`
                            .
                          * one_time -
                            The discount stays attached to the subscription till it is applied on an invoice **once**.
                            It is removed after that from the subscription.
                        enum:
                        - one_time
                        - forever
                        - limited_period
                        example: null
                      example: null
                    percentage:
                      type: array
                      description: |
                        The percentage of the original amount that should be deducted from it.
                      items:
                        type: number
                        format: double
                        deprecated: false
                        maximum: 100
                        minimum: 0.01
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        The value of the discount. [The format of this value](/docs/api/currencies)
                        depends on the kind of currency.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    period:
                      type: array
                      description: |
                        The duration of time for which the discount is attached to the subscription, in `period_units`.
                        Applicable only when `duration_type`
                        is `limited_period`.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    period_unit:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The unit of time for `period`.
                          Applicable only when `duration_type`
                          is `limited_period`.

                          * day - A period of 24 hours.
                          * week - A period of 7 days.
                          * month - A period of 1 calendar month.
                          * year - A period of 1 calendar year.
                        enum:
                        - day
                        - week
                        - month
                        - year
                        example: null
                      example: null
                    included_in_mrr:
                      type: array
                      description: |
                        The discount is included in MRR calculations for your site. This attribute is only applicable when `duration_type`
                        is `one_time`
                        and when the [feature is enabled](https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation)
                        in Chargebee. Also, If the [site-level setting](https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation)
                        is to exclude one-time discounts from MRR calculations, this value is always returned `false`.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    item_price_id:
                      type: array
                      description: |
                        The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                        in the subscription to which the discount is to be applied. Relevant only when `apply_on`
                        = `specific_item_price`.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Specifies the number of free units provided for the item, without affecting the total quantity sold
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    operation_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The operation to be carried out for the discount.

                          * add - The discount is attached to the subscription.
                          * remove -
                            The discount (given by `discounts[id]`
                            ) is removed from the subscription. Subsequent invoices will no longer have the discount applied. **Tip:**
                            If you want to replace a discount, `remove`
                            it and `add`
                            another in the same API call.
                        enum:
                        - add
                        - remove
                        example: null
                      example: null
                    id:
                      type: array
                      description: |
                        The id of the discount to be removed. This parameter is only relevant when `discounts[operation_type]`
                        is `remove`.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    start_date:
                      type: array
                      description: "Specifies the start date for the discount. The\
                        \ period of the discount, as specified by the `start_date`\
                        \ and `end_date` determines the [ramp(s)](/docs/api/quoted_ramps)\
                        \ it will be part of.  \n**Note**\n\nThe parameter applies\
                        \ only when Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    end_date:
                      type: array
                      description: "Specifies the end date for the discount. The period\
                        \ of the discount, as specified by the `start_date` and `end_date`\
                        \ determines the [ramp(s)](/docs/api/quoted_ramps) it will\
                        \ be part of.  \n**Note**\n\nThe parameter applies only when\
                        \ Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  required:
                  - duration_type
                  - operation_type
                  example: null
                item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_tiers
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The id of the item price for which the tier price is being overridden.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: |
                        The lowest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The highest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |
                        The overridden price of the tier. The value depends on the [type of currency](/docs/api/quotes)
                        .
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    pricing_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Pricing type for the tier.

                          * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                          * flat_fee -
                            Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                            pricing model, `pricing_type`
                            will be set to `flat_fee`
                            by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                          * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                        enum:
                        - per_unit
                        - flat_fee
                        - package
                        example: null
                      example: null
                    package_size:
                      type: array
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ramp_tier_id:
                      type: array
                      description: "The index or identifier of the [ramp](/docs/api/quoted_ramps)\
                        \ to which this tier information belongs. This must be a value\
                        \ from the `subscription_items[ramp_tier_id][i]`. Since an\
                        \ item price can be part of multiple subscriptions ramps,\
                        \ this group ID specifies the ramp to which this tier information\
                        \ belongs.  \n**Note**\n\nThe parameter applies only when\
                        \ Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 105
                        example: null
                      example: null
                  example: null
                coupons:
                  type: object
                  deprecated: false
                  description: ""
                  properties:
                    id:
                      type: array
                      description: "The [ID](/docs/api/coupons/coupon-object#id) of\
                        \ the coupon to be applied. [Coupon codes](/docs/api/coupon_codes)\
                        \ are not supported.  \n**Note**\n\nThe parameter applies\
                        \ only when Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    start_date:
                      type: array
                      description: "Specifies the start date for the coupon. The period\
                        \ of the coupon, as specified by the `start_date` and `end_date`\
                        \ determines the [ramp(s)](/docs/api/quoted_ramps) it will\
                        \ be part of.  \n**Note**\n\nThe parameter applies only when\
                        \ Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    end_date:
                      type: array
                      description: "Specifies the end date for the coupon. The period\
                        \ of the coupon, as specified by the `start_date` and `end_date`\
                        \ determines the [ramp(s)](/docs/api/quoted_ramps) it will\
                        \ be part of.  \n**Note**\n\nThe parameter applies only when\
                        \ Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
                entitlement_overrides:
                  type: object
                  deprecated: false
                  description: |
                    The set of entitlement overrides to apply on this quote. Each entry targets a feature for an entity on the quote. Overrides are always upserted.
                  properties:
                    feature_id:
                      type: array
                      description: |
                        The `id` of the `feature` for which the entitlement override is being set.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    entity_id:
                      type: array
                      description: |
                        The `id` of the entity on the quote (for example, a `plan_price`, `addon_price`, or `charge_price` handle from the quote context) whose entitlement is being overridden.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    entity_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The type of the entity on the quote for which the entitlement override is being set.

                          * plan_price - Indicates that the entity is an `item_price` with [`item_type`](/docs/api/item_prices/item-price-object#item_type) set to `plan`.
                          * charge_price - Indicates that the entity is an `item_price` with [`item_type`](/docs/api/item_prices/item-price-object#item_type) set to `charge`.
                          * addon_price - Indicates that the entity is an `item_price` with [`item_type`](/docs/api/item_prices/item-price-object#item_type) set to `addon`.
                        enum:
                        - plan_price
                        - addon_price
                        - charge_price
                        example: null
                      example: null
                    value:
                      type: array
                      description: |+
                        The level of entitlement that the item has towards the feature. The possible values depend on the value of `feature.type`
                        :

                        * When `feature.type` is `custom`: The value can be any one of `levels[].value`.

                        * When `feature.type` is `switch`: This value is `true` when the feature is available; it is `false` when the feature is unavailable.

                        * When `feature.type` is `quantity`:

                        * When `levels[].is_unlimited` is not `true`: The value can be any one of `levels[].value`.

                        * When `levels[].is_unlimited` is `true`: The value can also be any one of `levels[].value` or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.

                        * When `feature.type` is `range`:

                        * When `levels[].is_unlimited` is not `true`: The value can be any whole number between `levels[0].value` and `levels[1].value` (inclusive).

                        * When `levels[].is_unlimited` is `true`: The value can be any whole number equal to or greater than `levels[0].value` or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.

                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    is_enabled:
                      type: array
                      description: |
                        Specifies whether the entitlement for the feature is enabled (`true`) or disabled (`false`) for the entity on the quote.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    start_date:
                      type: array
                      description: |
                        Start date (UTC timestamp) of the entitlement override for the item on the quote. Used with `end_date` for ramp-scoped entitlements.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    end_date:
                      type: array
                      description: |
                        End date (UTC timestamp) of the entitlement override for the item on the quote. Used with `start_date` for ramp-scoped entitlements.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              billing_address:
                style: deepObject
                explode: true
              contract_term:
                style: deepObject
                explode: true
              coupons:
                style: deepObject
                explode: true
              customer:
                style: deepObject
                explode: true
              discounts:
                style: deepObject
                explode: true
              entitlement_overrides:
                style: deepObject
                explode: true
              item_tiers:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              subscription:
                style: deepObject
                explode: true
              subscription_items:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  quote:
                    $ref: "#/components/schemas/Quote"
                    description: |
                      Resource object representing quote
                  quoted_subscription:
                    $ref: "#/components/schemas/QuotedSubscription"
                    description: |
                      Resource object representing quoted_subscription
                  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:
    get:
      tags:
      - quotes
      summary: List quotes
      description: |
        List all quotes.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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_not\] = "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_not\] = "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\] = "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\[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: 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\[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: 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: Resource object representing quote
                        quoted_subscription:
                          $ref: "#/components/schemas/QuotedSubscription"
                          description: Resource object representing quoted_subscription
                        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}/convert:
    post:
      tags:
      - quotes
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    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 `pending`
                    , 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 `invoice_date`.
                    When passing this parameter, the following prerequisites must be met:

                    * `invoice_date` must be in the past.
                    * `invoice_date` 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.
                    * The date is not earlier than `quoted_subscription.start_date` or `quoted_subscription.changes_scheduled_at` (whichever is applicable).
                    * `invoice_immediately` must be `true`. .
                  example: null
                invoice_immediately:
                  type: boolean
                  deprecated: false
                  description: "If there are charges raised immediately for the subscription,\
                    \ this parameter specifies whether those charges are to be invoiced\
                    \ immediately or added to [unbilled charges](https://www.chargebee.com/docs/unbilled-charges.html).\n\
                    The default value is as per the [site settings](https://www.chargebee.com/docs/unbilled-charges.html#configuration)\n\
                    .  \n**Note:**\n`invoice_immediately`\nonly 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.\n\n.\n"
                  example: null
                create_pending_invoices:
                  type: boolean
                  deprecated: false
                  description: |
                    This attribute is set to `true`
                    automatically for the subscription when it has one or more `metered`
                    items. However, when there are no `metered`
                    items, you can pass this parameter as `true`
                    to force all invoices (except the first) to be created as `pending`.
                    This is useful in the following scenarios:

                    * When you manage metered billing at your end by calculating usage-based charges yourself and add them to the subscription as [one-time charges](https://www.chargebee.com/docs/2.0/charges.html).
                    * When your workflow involves inspecting all charges before you close invoices.

                    **Note:**

                    * You must enable [Metered Billing](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing) for this parameter to be acceptable.
                    * To create the first invoice also as `pending`, pass `first_invoice_pending` as `true`.

                    .
                  example: null
                first_invoice_pending:
                  type: boolean
                  default: false
                  deprecated: false
                  description: "Non-metered items are billed at the beginning of a\
                    \ billing cycle while metered items are billed at the end. Consequently,\
                    \ the first invoice of the subscription contains only the non-metered\
                    \ items.\n\nBy passing this parameter as `true`, you create the\
                    \ first invoice as `pending` allowing you to add the previous\
                    \ term's metered charges to it before closing. This is useful\
                    \ when the subscription is moved to Chargebee from a different\
                    \ billing system. As applicable to all `pending` invoices, this\
                    \ invoice is also [closed automatically](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing)\
                    \ or via an [API call](/docs/api/invoices/close-a-pending-invoice).\
                    \  \n**Note:**\n\nThis parameter is passed only when there are\
                    \ metered items in the subscription or when `create_pending_invoices`\
                    \ is `true`.\n\n.\n"
                  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
                    auto_close_invoices:
                      type: boolean
                      deprecated: false
                      description: |
                        When [auto-closing of invoices](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing)
                        is enabled for the site, you can pass this parameter as `false`
                        to prevent the automatic closing of invoices for this subscription. The value passed here takes precedence over the value stored at the [customer level](/docs/api/customers/customer-object#auto_close_invoices)
                        .
                      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: |
                      Resource object representing quote
                  quoted_subscription:
                    $ref: "#/components/schemas/QuotedSubscription"
                    description: |
                      Resource object representing quoted_subscription
                  quoted_charge:
                    $ref: "#/components/schemas/QuotedCharge"
                    description: |
                      Resource object representing quoted_charge
                  quoted_ramp:
                    $ref: "#/components/schemas/QuotedRamp"
                    description: |
                      Resource object representing quoted_ramp
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: |
                      Resource object representing customer
                  subscription:
                    $ref: "#/components/schemas/Subscription"
                    description: |
                      Resource object representing subscription
                  invoice:
                    $ref: "#/components/schemas/Invoice"
                    description: |
                      Resource object representing invoice
                  credit_note:
                    $ref: "#/components/schemas/CreditNote"
                    description: |
                      Resource object representing credit_note
                  unbilled_charges:
                    type: array
                    description: |
                      Resource object representing unbilled_charge
                    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:
      tags:
      - quotes
      summary: Delete a quote
      description: |
        Delete a 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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing quote
                  quoted_subscription:
                    $ref: "#/components/schemas/QuotedSubscription"
                    description: |
                      Resource object representing quoted_subscription
                  quoted_charge:
                    $ref: "#/components/schemas/QuotedCharge"
                    description: |
                      Resource object representing quoted_charge
                  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_for_items:
    post:
      tags:
      - quotes
      summary: Edit a quote for subscription creation
      description: |
        Changes the quote produced for creating a new subscription items
      operationId: edit_create_subscription_quote_for_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
              additionalProperties: true
              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: |
                    The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles [set for the plan-item price](/docs/api/item_prices/item_price-object#billing_cycles)
                    is used.
                  minimum: 0
                  example: null
                mandatory_items_to_remove:
                  type: array
                  deprecated: false
                  description: |
                    Item ids of [mandatorily attached addons](/docs/api/attached_items)
                    that are 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: "The list of [IDs](/docs/api/coupons/coupon-object#id)\
                    \ of the coupons to be applied. [Coupon codes](/docs/api/coupon_codes)\
                    \ are also supported.  \n**Note**\n\nNot applicable when Chargebee\
                    \ CPQ is enabled. Use `coupons[]` array instead.\n"
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                billing_start_option:
                  type: string
                  default: on_specific_date
                  deprecated: false
                  description: "When the quote is converted, this attribute determines\
                    \ the date/time as of when the subscription start is to be carried\
                    \ out.  \n**Note**\n\nThe parameter applies only when Chargebee\
                    \ CPQ is enabled. To request access, 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\
                    \n* on_specific_date - Upon quote conversion, the subscription\
                    \ is scheduled to start on the specified date.\n* immediately\
                    \ - The subscription starts immediately upon conversion of the\
                    \ quote to a subscription.\n"
                  enum:
                  - immediately
                  - on_specific_date
                  example: null
                net_term_days:
                  type: integer
                  format: int32
                  deprecated: false
                  description: "The number of days from [`invoice.date`](/docs/api/invoices/invoice-object#date)\
                    \ until payment for the invoice is due.  \n**Note**\nThe parameter\
                    \ applies only when Chargebee CPQ is enabled. To request access,\
                    \ 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"
                  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
                    po_number:
                      type: string
                      deprecated: false
                      description: |
                        Purchase order number for this subscription.
                      maxLength: 100
                      example: null
                    trial_end:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        End of the trial period for the subscription. This overrides the trial period set for the plan-item. The value must be later than `start_date`.
                        Set it to `0`
                        to have no trial period.
                      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 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:

                        * Backdating is enabled for subscription creation operations.
                        * 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.
                        * 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, `subscription[start_date]` cannot be earlier than 14th February.
                      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: |
                        Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as `billing_cycles`
                        or a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)
                        .
                      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 extended free of charge. The value is\
                        \ expressed in the time unit specified by `free_period_unit`.\
                        \ For example, `3` with `free_period_unit` = `month` adds\
                        \ 3 free months to the first term of the subscription.  \n\
                        \n**Prerequisite**\nCan be used only when Chargebee CPQ is\
                        \ enabled. To request access, [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\
                        \n\n"
                      minimum: 1
                      example: null
                    free_period_unit:
                      type: string
                      deprecated: false
                      description: "The time unit for `free_period`.  \n\n**Prerequisite**\n\
                        Can be used only when Chargebee CPQ is enabled. To request\
                        \ access, [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\
                        \n**Constraint**\nMust be equal to or lower than the [`period_unit`](/docs/api/item_prices#period_unit)\
                        \ of the plan [item price](/quotes/edit-create-subscription-quote-for-items#subscription_items_item_price_id)\
                        \ of the subscription.\n\n* year - Charge based on year(s)\n\
                        * day - Charge based on day(s)\n* month - Charge based on\
                        \ month(s)\n* week - Charge based on week(s)\n"
                      enum:
                      - day
                      - week
                      - month
                      - year
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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: |
                        Action to be taken when the contract term completes.

                        * evergreen - Contract term completes and the subscription renews.
                        * renew -
                          * Contract term completes and a new contract term is started for the number of billing cycles specified in [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).
                          * The `action_at_term_end` for the new contract term is set to `renew`.
                        * cancel - Contract term completes and subscription is canceled.
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      default: 0
                      deprecated: false
                      description: |
                        The number of days before [`contract_end`](/docs/api/contract_terms/contract_term-object#contract_end)
                        , 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.
                      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.  \n**Note**\n\
                        The parameter `billing_address` and all its sub-parameters\
                        \ apply only when Chargebee CPQ is enabled. To request access,\
                        \ 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"
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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
                    country:
                      type: string
                      deprecated: false
                      description: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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
                subscription_items:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription_items
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The unique identifier of the item price.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        The quantity of the item purchased
                      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 item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        The price/per unit price of the item. When not provided, [the value set](/docs/api/item_prices/item-price-object)
                        for the item price is used. This is only applicable when the `pricing_model`
                        of the item price is `flat_fee`
                        or `per_unit`.
                        Also, it is only allowed when [price overriding](https://www.chargebee.com/docs/price-override.html)
                        is enabled for the site. The value depends on the type of currency. If `changes_scheduled_at`
                        is in the past and a `unit_price`
                        is not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](https://www.chargebee.com/docs/2.0/price-override.html)
                        is enabled for the site, the price or per-unit price of the item can be set here. The [value set for the item price](/docs/api/item_prices/item_price-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/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        For the plan-item price:
                        the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then [the value set](/docs/api/item_prices/item-price-object)
                        for the plan-item price is used.

                        For addon-item prices:
                        If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)
                        are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then [the value set under attached addons](/docs/api/attached_items/attached-item-object)
                        is used. Further, if that value is not provided, then [the value set for the addon-item price](/docs/api/item_prices/item-price-object)
                        is used.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    trial_end:
                      type: array
                      description: |
                        The date/time when the trial period of the item ends. Applies to plan-items and--when [enabled](https://www.chargebee.com/docs/2.0/addons-trial.html)
                        --addon-items as well.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    service_period_days:
                      type: array
                      description: |
                        The service period of the item in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 730
                        minimum: 1
                        example: null
                      example: null
                    charge_on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          When `charge_on_option`
                          option is set to `on_event`
                          , this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.

                          * contract_termination -
                            when a contract term is [terminated](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option)
                            .
                          * subscription_trial_start - the time when the trial period of the subscription begins.
                          * plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                          * subscription_activation -
                            the moment a subscription enters an `active`
                            or `non-renewing`
                            state. Also includes reactivations of canceled subscriptions.
                          * subscription_creation - the time of creation of the subscription.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        Indicates if the charge-item is to be charged only once or each time the `charge_on_event`
                        occurs. This parameter only applies to charge-items.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    charge_on_option:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates when the charge-item is to be charged. This parameter only applies to charge-items.

                          * on_event -
                            The item is charged at the occurrence of the event specified as `charge_on_event`
                            .
                          * immediately - The item is charged immediately on being added to the subscription.
                        enum:
                        - immediately
                        - on_event
                        example: null
                      example: null
                    start_date:
                      type: array
                      description: "Specifies the start date for the item price in\
                        \ the subscription. The period of the item price, determined\
                        \ by the `start_date` and `end_date`, specifies the [ramp](/docs/api/quoted_ramps)\
                        \ it belongs to.  \n**Note**\n\nThe parameter applies only\
                        \ when Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    end_date:
                      type: array
                      description: "Specifies the end date for the item price in the\
                        \ subscription. The period of the item price, determined by\
                        \ the `start_date` and `end_date`, specifies the [ramp](/docs/api/quoted_ramps)\
                        \ it belongs to.  \n**Note**\n\nThe parameter applies only\
                        \ when Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    description:
                      type: array
                      description: ""
                      items:
                        type: string
                        deprecated: false
                        maxLength: 2000
                        example: null
                      example: null
                    ramp_tier_id:
                      type: array
                      description: "The index or identifier of the [ramp](/docs/api/quoted_ramps)\
                        \ to which the item price belongs. Use this index to map `item_tier`\
                        \ values to the correct ramp, as the target `item_price` of\
                        \ an `item_tier` may be part of multiple ramps.  \n**Note**\n\
                        \nThe parameter applies only when Chargebee CPQ is enabled.\
                        \ To request access, 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"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 105
                        example: null
                      example: null
                  required:
                  - item_price_id
                  example: null
                discounts:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for discounts
                  properties:
                    apply_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The amount on the quote to which the discount is applied.

                          * invoice_amount -
                            The discount is applied to the invoice `sub_total`
                            .
                          * specific_item_price -
                            The discount is applied to the `invoice.line_item.amount`
                            that corresponds to the item price specified by `item_price_id`
                            .
                        enum:
                        - invoice_amount
                        - specific_item_price
                        example: null
                      example: null
                    duration_type:
                      type: array
                      items:
                        type: string
                        default: forever
                        deprecated: false
                        description: |
                          Specifies the time duration for which this discount is attached to the subscription.

                          * forever -
                            The discount is attached to the subscription and applied on the invoices till it is [explicitly removed](/docs/api/subscriptions/update-subscription-for-items#discounts_operation_type)
                            .
                          * 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 `period`
                            and `period_unit`
                            .
                          * one_time -
                            The discount stays attached to the subscription till it is applied on an invoice **once**.
                            It is removed after that from the subscription.
                        enum:
                        - one_time
                        - forever
                        - limited_period
                        example: null
                      example: null
                    percentage:
                      type: array
                      description: |
                        The percentage of the original amount that should be deducted from it.
                      items:
                        type: number
                        format: double
                        deprecated: false
                        maximum: 100
                        minimum: 0.01
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        The value of the discount. [The format of this value](/docs/api/currencies)
                        depends on the kind of currency.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    period:
                      type: array
                      description: |
                        The duration of time for which the discount is attached to the subscription, in `period_units`.
                        Applicable only when `duration_type`
                        is `limited_period`.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    period_unit:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The unit of time for `period`.
                          Applicable only when `duration_type`
                          is `limited_period`.

                          * day - A period of 24 hours.
                          * week - A period of 7 days.
                          * month - A period of 1 calendar month.
                          * year - A period of 1 calendar year.
                        enum:
                        - day
                        - week
                        - month
                        - year
                        example: null
                      example: null
                    included_in_mrr:
                      type: array
                      description: |
                        The discount is included in MRR calculations for your site. This attribute is only applicable when `duration_type`
                        is `one_time`
                        and when the [feature is enabled](https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation)
                        in Chargebee. Also, If the [site-level setting](https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation)
                        is to exclude one-time discounts from MRR calculations, this value is always returned `false`.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    item_price_id:
                      type: array
                      description: |
                        The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                        in the subscription to which the discount is to be applied. Relevant only when `apply_on`
                        = `specific_item_price`.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Specifies the number of free units provided for the item, without affecting the total quantity sold
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    start_date:
                      type: array
                      description: "Specifies the start date for the discount. The\
                        \ period of the discount, as specified by the `start_date`\
                        \ and `end_date` determines the [ramp(s)](/docs/api/quoted_ramps)\
                        \ it will be part of.  \n**Note**\n\nThe parameter applies\
                        \ only when Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    end_date:
                      type: array
                      description: "Specifies the end date for the discount. The period\
                        \ of the discount, as specified by the `start_date` and `end_date`\
                        \ determines the [ramp(s)](/docs/api/quoted_ramps) it will\
                        \ be part of.  \n**Note**\n\nThe parameter applies only when\
                        \ Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  required:
                  - duration_type
                  example: null
                item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_tiers
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The id of the item price for which the tier price is being overridden.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: |
                        The lowest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The highest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |
                        The overridden price of the tier. The value depends on the [type of currency](/docs/api/quotes)
                        .
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    pricing_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Pricing type for the tier.

                          * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                          * flat_fee -
                            Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                            pricing model, `pricing_type`
                            will be set to `flat_fee`
                            by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                          * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                        enum:
                        - per_unit
                        - flat_fee
                        - package
                        example: null
                      example: null
                    package_size:
                      type: array
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ramp_tier_id:
                      type: array
                      description: "The index or identifier of the [ramp](/docs/api/quoted_ramps)\
                        \ to which this tier information belongs. This must be a value\
                        \ from the `subscription_items[ramp_tier_id][i]`. Since an\
                        \ item price can be part of multiple subscriptions ramps,\
                        \ this group ID specifies the ramp to which this tier information\
                        \ belongs.  \n**Note**\n\nThe parameter applies only when\
                        \ Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 105
                        example: null
                      example: null
                  example: null
                coupons:
                  type: object
                  deprecated: false
                  description: ""
                  properties:
                    id:
                      type: array
                      description: "The [ID](/docs/api/coupons/coupon-object#id) of\
                        \ the coupon to be applied. [Coupon codes](/docs/api/coupon_codes)\
                        \ are not supported.  \n**Note**\n\nThe parameter applies\
                        \ only when Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    start_date:
                      type: array
                      description: "Specifies the start date for the coupon. The period\
                        \ of the coupon, as specified by the `start_date` and `end_date`\
                        \ determines the [ramp(s)](/docs/api/quoted_ramps) it will\
                        \ be part of.  \n**Note**\n\nThe parameter applies only when\
                        \ Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    end_date:
                      type: array
                      description: "Specifies the end date for the coupon. The period\
                        \ of the coupon, as specified by the `start_date` and `end_date`\
                        \ determines the [ramp(s)](/docs/api/quoted_ramps) it will\
                        \ be part of.  \n**Note**\n\nThe parameter applies only when\
                        \ Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
                entitlement_overrides:
                  type: object
                  deprecated: false
                  description: |
                    The set of entitlement overrides to apply on this quote. Each entry targets a feature for an entity on the quote. Overrides are always upserted.
                  properties:
                    feature_id:
                      type: array
                      description: |
                        The `id` of the `feature` for which the entitlement override is being set.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    entity_id:
                      type: array
                      description: |
                        The `id` of the entity on the quote (for example, a `plan_price`, `addon_price`, or `charge_price` handle from the quote context) whose entitlement is being overridden.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    entity_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The type of the entity on the quote for which the entitlement override is being set.

                          * plan_price - Indicates that the entity is an `item_price` with [`item_type`](/docs/api/item_prices/item-price-object#item_type) set to `plan`.
                          * charge_price - Indicates that the entity is an `item_price` with [`item_type`](/docs/api/item_prices/item-price-object#item_type) set to `charge`.
                          * addon_price - Indicates that the entity is an `item_price` with [`item_type`](/docs/api/item_prices/item-price-object#item_type) set to `addon`.
                        enum:
                        - plan_price
                        - addon_price
                        - charge_price
                        example: null
                      example: null
                    value:
                      type: array
                      description: |+
                        The level of entitlement that the item has towards the feature. The possible values depend on the value of `feature.type`
                        :

                        * When `feature.type` is `custom`: The value can be any one of `levels[].value`.

                        * When `feature.type` is `switch`: This value is `true` when the feature is available; it is `false` when the feature is unavailable.

                        * When `feature.type` is `quantity`:

                        * When `levels[].is_unlimited` is not `true`: The value can be any one of `levels[].value`.

                        * When `levels[].is_unlimited` is `true`: The value can also be any one of `levels[].value` or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.

                        * When `feature.type` is `range`:

                        * When `levels[].is_unlimited` is not `true`: The value can be any whole number between `levels[0].value` and `levels[1].value` (inclusive).

                        * When `levels[].is_unlimited` is `true`: The value can be any whole number equal to or greater than `levels[0].value` or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.

                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    is_enabled:
                      type: array
                      description: |
                        Specifies whether the entitlement for the feature is enabled (`true`) or disabled (`false`) for the entity on the quote.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    start_date:
                      type: array
                      description: |
                        Start date (UTC timestamp) of the entitlement override for the item on the quote. Used with `end_date` for ramp-scoped entitlements.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    end_date:
                      type: array
                      description: |
                        End date (UTC timestamp) of the entitlement override for the item on the quote. Used with `start_date` for ramp-scoped entitlements.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              billing_address:
                style: deepObject
                explode: true
              contract_term:
                style: deepObject
                explode: true
              coupons:
                style: deepObject
                explode: true
              discounts:
                style: deepObject
                explode: true
              entitlement_overrides:
                style: deepObject
                explode: true
              item_tiers:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              subscription:
                style: deepObject
                explode: true
              subscription_items:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  quote:
                    $ref: "#/components/schemas/Quote"
                    description: |
                      Resource object representing quote
                  quoted_subscription:
                    $ref: "#/components/schemas/QuotedSubscription"
                    description: |
                      Resource object representing quoted_subscription
                  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_for_items:
    post:
      tags:
      - quotes
      summary: Create a quote for subscription update
      description: "Creates a quote for updating a subscription.  \n\n### Impacts\n\
        \n**#### Quote and related resources**  \nIf the quote is for a scheduled\
        \ change, then the following resources are created:\n\n* When [Ramps](/docs/api/ramps)\
        \ are disabled, a `quote` and a [`quoted_subscription`](/docs/api/quoted_subscriptions)\
        \ are created.\n* When [Ramps](/docs/api/ramps) are enabled with compatibility\
        \ mode, a `quote`, a [`quoted_ramp`](/docs/api/quoted_ramps), and a [`quoted_subscription`](/docs/api/quoted_subscriptions)\
        \ are created.\n\nFor more details, see [Ramps API compatibility mode](/docs/api/subscriptions#ramps-compat-mode).\n"
      operationId: create_a_quote_for_update_subscription_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
              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
                mandatory_items_to_remove:
                  type: array
                  deprecated: false
                  description: |
                    Item ids of [mandatorily attached addons](/docs/api/attached_items)
                    that are to be removed from the subscription.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                replace_items_list:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    If `true`
                    then the existing `subscription_items`
                    list for the subscription is replaced by the one provided. If `false`
                    then the provided `subscription_items`
                    list gets added to the existing list.
                  example: null
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Billing cycles set for plan-item price is used by default.
                  minimum: 0
                  example: null
                terms_to_charge:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of subscription billing cycles to [invoice in advance](https://www.chargebee.com/docs/advance-invoices.html).
                    If a new term is started for the subscription due to this API call, then `terms_to_charge`
                    is inclusive of this new term. See description for the `force_term_reset`
                    parameter to learn more about when a subscription term is reset.
                  minimum: 1
                  example: null
                reactivate_from:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    If the subscription `status`
                    is `cancelled`
                    and it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.
                    **Note:**
                    It is recommended not to pass this parameter along with `changed_scheduled_at`.
                    `reactivate_from`
                    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:

                    * Backdating must be enabled for subscription reactivation operations.
                    * 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.
                    * The date is on or after the last date/time any of the product catalog items of the subscription were changed.
                    * 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, `changes_scheduled_at` cannot be earlier than 14th February. .
                  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: "The list of [IDs](/docs/api/coupons/coupon-object#id)\
                    \ of the coupons to be applied. [Coupon codes](/docs/api/coupon_codes)\
                    \ are also supported.  \n**Note**\n\nNot applicable when Chargebee\
                    \ CPQ is enabled. Use `coupons[]` array instead.\n"
                  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: |
                    When the quote is converted, this attribute determines the date/time as of when the subscription change is to be carried out.

                    * specific_date -
                      The change is carried out as of the date specified under `changes_scheduled_at`
                      .
                    * immediately - The change is carried out immediately.
                  enum:
                  - immediately
                  - specific_date
                  example: null
                changes_scheduled_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: "When `change_option` is set to `specific_date`, then\
                    \ set the date-time at which the subscription change is to happen\
                    \ or has happened.  \n**Constraints**\n\n* Do not pass this parameter\
                    \ along with `reactivate_from`.\n* The `changes_scheduled_at`\
                    \ parameter does not apply to `auto_collection`, `shipping_address`,\
                    \ and `po_number`; these parameters take effect **immediately**\
                    \ when scheduling a subscription update.  \n**Backdated changes**\n\
                    \n`changes_scheduled_at`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:\n\n* Backdating must be\
                    \ [enabled](https://www.chargebee.com/docs/billing/2.0/subscriptions/backdating#configuring-backdated-subscription-actions-and-invoicing)\
                    \ for subscription change operations.\n* Only the following changes\
                    \ can be backdated:\n  * Changes in the recurring items or their\
                    \ prices.\n  * Addition of non-recurring items.\n* Subscription\
                    \ `status` is `active`, `cancelled`, or `non_renewing`.\n* 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.\n* The date is on or after `current_term_start`.\n\
                    * The date is on or after the last date/time any of the following\
                    \ changes were made:\n  * Changes in the recurring items or their\
                    \ prices.\n  * Addition of non-recurring items.\n"
                  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
                net_term_days:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of days from [`invoice.date`](/docs/api/invoices/invoice-object#date) until payment for the invoice is due.

                    **Note:** This parameter applies only when Chargebee CPQ is enabled. To request access, 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)
                  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
                    start_date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The new start date of a `future`
                        subscription. Applicable only for `future`
                        subscriptions.
                      example: null
                    trial_end:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The time at which the trial has ended or will end for the subscription. This is only allowed when the subscription `status`
                        is `future`
                        , `in_trial`
                        , or `cancelled`.
                        Also, the value must not be earlier than `changes_scheduled_at`
                        or `start_date`.
                        **Note** :
                        This parameter can be backdated (set to a value in the past) only when the subscription is in `cancelled`
                        or `in_trial`
                        `status`.
                        Do this to keep a record of when the trial ended in case it ended at some point in the past. When `trial_end`
                        is backdated, the subscription immediately goes into `active`
                        or `non_renewing`
                        status.
                      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: |
                        Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as `billing_cycles`
                        or a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)
                        .
                      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.  \n**Note**\n\
                        \nThe parameter `billing_address` and all its sub-parameters\
                        \ apply only when Chargebee CPQ is enabled. To request access,\
                        \ 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"
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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: |
                        An overridden value for the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number).
                        Only applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)

                        `country`
                        as `XI`
                        (which is **United Kingdom - Northern Ireland**
                        ).

                        When you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)
                        in 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)
                        the Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)

                        `country`
                        as `XI`.
                        That's the code for **United Kingdom - Northern Ireland** .
                        The first two characters of the VAT number in such a case is
                        `XI`
                        by default. However, if the VAT number was registered in UK, the value should be `GB`.
                        Set
                        `vat_number_prefix`
                        to `GB`
                        for such cases.
                      maxLength: 10
                      example: null
                    registered_for_gst:
                      type: boolean
                      deprecated: false
                      description: |
                        Confirms that a customer is registered under GST. If set to `true`
                        then the [Reverse Charge Mechanism](https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism)
                        is applicable. This field is applicable only when Australian GST is configured for your site.
                      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: |
                        Action to be taken when the contract term completes.

                        * evergreen - Contract term completes and the subscription renews.
                        * renew -
                          * Contract term completes and a new contract term is started for the number of billing cycles specified in [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).
                          * The `action_at_term_end` for the new contract term is set to `renew`.
                        * renew_once -
                          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 [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).

                          * The `action_at_term_end` for the new contract term is set to `cancel`.
                        * cancel - Contract term completes and subscription is canceled.
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      - renew_once
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        The number of days before [`contract_end`](/docs/api/contract_terms/contract_term-object#contract_end)
                        , 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.
                      example: null
                  example: null
                subscription_items:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription_items
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The unique identifier of the item price.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        The quantity of the item purchased
                      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 item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        The price/per unit price of the item. When not provided, [the value set](/docs/api/item_prices/item-price-object)
                        for the item price is used. This is only applicable when the `pricing_model`
                        of the item price is `flat_fee`
                        or `per_unit`.
                        Also, it is only allowed when [price overriding](https://www.chargebee.com/docs/price-override.html)
                        is enabled for the site. The value depends on the type of currency. If `changes_scheduled_at`
                        is in the past and a `unit_price`
                        is not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      description: |
                        When [price overriding](https://www.chargebee.com/docs/price-override.html)
                        is enabled for the site, the price or per-unit price of the item can be set here. The [value set for the item price](/docs/api/item_prices/item_price-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/getting-started)
                        is enabled. If `changes_scheduled_at`
                        is in the past and a `unit_price_in_decimal`
                        is not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        For the plan-item price:
                        the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then [the value set](/docs/api/item_prices/item-price-object)
                        for the plan-item price is used.

                        For addon-item prices:
                        If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)
                        are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then [the value set under attached addons](/docs/api/attached_items/attached-item-object)
                        is used. Further, if that value is not provided, then [the value set for the addon-item price](/docs/api/item_prices/item-price-object)
                        is used.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    trial_end:
                      type: array
                      description: |
                        The date/time when the trial period of the item ends. Applies to plan-items and--when [enabled](https://www.chargebee.com/docs/2.0/addons-trial.html)
                        --addon-items as well.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    service_period_days:
                      type: array
                      description: |
                        The service period of the item in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 730
                        minimum: 1
                        example: null
                      example: null
                    charge_on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          When `charge_on_option`
                          option is set to `on_event`
                          , this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.

                          * contract_termination -
                            when a contract term is [terminated](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option)
                            .
                          * subscription_trial_start - the time when the trial period of the subscription begins.
                          * plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                          * subscription_activation -
                            the moment a subscription enters an `active`
                            or `non-renewing`
                            state. Also includes reactivations of canceled subscriptions.
                          * subscription_creation - the time of creation of the subscription.
                        enum:
                        - subscription_creation
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        Indicates if the charge-item is to be charged only once or each time the `charge_on_event`
                        occurs. This parameter only applies to charge-items.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    charge_on_option:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates when the charge-item is to be charged. This parameter only applies to charge-items.

                          * on_event -
                            The item is charged at the occurrence of the event specified as `charge_on_event`
                            .
                          * immediately - The item is charged immediately on being added to the subscription.
                        enum:
                        - immediately
                        - on_event
                        example: null
                      example: null
                    start_date:
                      type: array
                      description: "Specifies the start date for the item price in\
                        \ the subscription. The period of the item price, determined\
                        \ by the `start_date` and `end_date`, specifies the [ramp](/docs/api/quoted_ramps)\
                        \ it belongs to.  \n**Note**\n\nThe parameter applies only\
                        \ when Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    end_date:
                      type: array
                      description: "Specifies the end date for the item price in the\
                        \ subscription. The period of the item price, determined by\
                        \ the `start_date` and `end_date`, specifies the [ramp](/docs/api/quoted_ramps)\
                        \ it belongs to.  \n**Note**\n\nThe parameter applies only\
                        \ when Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    description:
                      type: array
                      description: ""
                      items:
                        type: string
                        deprecated: false
                        maxLength: 2000
                        example: null
                      example: null
                    ramp_tier_id:
                      type: array
                      description: "The index or identifier of the [ramp](/docs/api/quoted_ramps)\
                        \ to which the item price belongs. Use this index to map `item_tier`\
                        \ values to the correct ramp, as the target `item_price` of\
                        \ an `item_tier` may be part of multiple ramps.  \n**Note**\n\
                        \nThe parameter applies only when Chargebee CPQ is enabled.\
                        \ To request access, 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"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 105
                        example: null
                      example: null
                  required:
                  - item_price_id
                  example: null
                discounts:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for discounts
                  properties:
                    apply_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The amount on the quote to which the discount is applied.

                          * invoice_amount -
                            The discount is applied to the invoice `sub_total`
                            .
                          * specific_item_price -
                            The discount is applied to the `invoice.line_item.amount`
                            that corresponds to the item price specified by `item_price_id`
                            .
                        enum:
                        - invoice_amount
                        - specific_item_price
                        example: null
                      example: null
                    duration_type:
                      type: array
                      items:
                        type: string
                        default: forever
                        deprecated: false
                        description: |
                          Specifies the time duration for which this discount is attached to the subscription.

                          * forever -
                            The discount is attached to the subscription and applied on the invoices till it is [explicitly removed](/docs/api/subscriptions/update-subscription-for-items#discounts_operation_type)
                            .
                          * 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 `period`
                            and `period_unit`
                            .
                          * one_time -
                            The discount stays attached to the subscription till it is applied on an invoice **once**.
                            It is removed after that from the subscription.
                        enum:
                        - one_time
                        - forever
                        - limited_period
                        example: null
                      example: null
                    percentage:
                      type: array
                      description: |
                        The percentage of the original amount that should be deducted from it.
                      items:
                        type: number
                        format: double
                        deprecated: false
                        maximum: 100
                        minimum: 0.01
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        The value of the discount. [The format of this value](/docs/api/currencies)
                        depends on the kind of currency.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    period:
                      type: array
                      description: |
                        The duration of time for which the discount is attached to the subscription, in `period_units`.
                        Applicable only when `duration_type`
                        is `limited_period`.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    period_unit:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The unit of time for `period`.
                          Applicable only when `duration_type`
                          is `limited_period`.

                          * day - A period of 24 hours.
                          * week - A period of 7 days.
                          * month - A period of 1 calendar month.
                          * year - A period of 1 calendar year.
                        enum:
                        - day
                        - week
                        - month
                        - year
                        example: null
                      example: null
                    included_in_mrr:
                      type: array
                      description: |
                        The discount is included in MRR calculations for your site. This attribute is only applicable when `duration_type`
                        is `one_time`
                        and when the [feature is enabled](https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation)
                        in Chargebee. Also, If the [site-level setting](https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation)
                        is to exclude one-time discounts from MRR calculations, this value is always returned `false`.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    item_price_id:
                      type: array
                      description: |
                        The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                        in the subscription to which the discount is to be applied. Relevant only when `apply_on`
                        = `specific_item_price`.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Specifies the number of free units provided for the item, without affecting the total quantity sold
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    operation_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The operation to be carried out for the discount.

                          * add - The discount is attached to the subscription.
                          * remove -
                            The discount (given by `discounts[id]`
                            ) is removed from the subscription. Subsequent invoices will no longer have the discount applied. **Tip:**
                            If you want to replace a discount, `remove`
                            it and `add`
                            another in the same API call.
                        enum:
                        - add
                        - remove
                        example: null
                      example: null
                    id:
                      type: array
                      description: |
                        The `id`
                        of the discount to be removed. This parameter is only relevant when `discounts[operation_type]`
                        is `remove`.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    start_date:
                      type: array
                      description: "Specifies the start date for the discount. The\
                        \ period of the discount, as specified by the `start_date`\
                        \ and `end_date` determines the [ramp(s)](/docs/api/quoted_ramps)\
                        \ it will be part of.  \n**Note**\n\nThe parameter applies\
                        \ only when Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    end_date:
                      type: array
                      description: "Specifies the end date for the discount. The period\
                        \ of the discount, as specified by the `start_date` and `end_date`\
                        \ determines the [ramp(s)](/docs/api/quoted_ramps) it will\
                        \ be part of.  \n**Note**\n\nThe parameter applies only when\
                        \ Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  required:
                  - duration_type
                  - operation_type
                  example: null
                item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_tiers
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The id of the item price for which the tier price is being overridden.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: |
                        The lowest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The highest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |
                        The overridden price of the tier. The value depends on the [type of currency](/docs/api/quotes)
                        .
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    pricing_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Pricing type for the tier.

                          * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                          * flat_fee -
                            Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                            pricing model, `pricing_type`
                            will be set to `flat_fee`
                            by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                          * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                        enum:
                        - per_unit
                        - flat_fee
                        - package
                        example: null
                      example: null
                    package_size:
                      type: array
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ramp_tier_id:
                      type: array
                      description: "The index or identifier of the [ramp](/docs/api/quoted_ramps)\
                        \ to which this tier information belongs. This must be a value\
                        \ from the `subscription_items[ramp_tier_id][i]`. Since an\
                        \ item price can be part of multiple subscriptions ramps,\
                        \ this group ID specifies the ramp to which this tier information\
                        \ belongs.  \n**Note**\n\nThe parameter applies only when\
                        \ Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 105
                        example: null
                      example: null
                  example: null
                coupons:
                  type: object
                  deprecated: false
                  description: ""
                  properties:
                    id:
                      type: array
                      description: "The [ID](/docs/api/coupons/coupon-object#id) of\
                        \ the coupon to be applied. [Coupon codes](/docs/api/coupon_codes)\
                        \ are not supported.  \n**Note**\n\nThe parameter applies\
                        \ only when Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    start_date:
                      type: array
                      description: "Specifies the start date for the coupon. The period\
                        \ of the coupon, as specified by the `start_date` and `end_date`\
                        \ determines the [ramp(s)](/docs/api/quoted_ramps) it will\
                        \ be part of.  \n**Note**\n\nThe parameter applies only when\
                        \ Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    end_date:
                      type: array
                      description: "Specifies the end date for the coupon. The period\
                        \ of the coupon, as specified by the `start_date` and `end_date`\
                        \ determines the [ramp(s)](/docs/api/quoted_ramps) it will\
                        \ be part of.  \n**Note**\n\nThe parameter applies only when\
                        \ Chargebee CPQ is enabled. To request access, 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"
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
                entitlement_overrides:
                  type: object
                  deprecated: false
                  description: |
                    The set of entitlement overrides to apply on this quote. Each entry targets a feature for an entity on the quote. Overrides are always upserted.
                  properties:
                    feature_id:
                      type: array
                      description: |
                        The `id` of the `feature` for which the entitlement override is being set.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    entity_id:
                      type: array
                      description: |
                        The `id` of the entity on the quote (for example, a `plan_price`, `addon_price`, or `charge_price` handle from the quote context) whose entitlement is being overridden.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    entity_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The type of the entity on the quote for which the entitlement override is being set.

                          * plan_price - Indicates that the entity is an `item_price` with [`item_type`](/docs/api/item_prices/item-price-object#item_type) set to `plan`.
                          * charge_price - Indicates that the entity is an `item_price` with [`item_type`](/docs/api/item_prices/item-price-object#item_type) set to `charge`.
                          * addon_price - Indicates that the entity is an `item_price` with [`item_type`](/docs/api/item_prices/item-price-object#item_type) set to `addon`.
                        enum:
                        - plan_price
                        - addon_price
                        - charge_price
                        example: null
                      example: null
                    value:
                      type: array
                      description: |+
                        The level of entitlement that the item has towards the feature. The possible values depend on the value of `feature.type`
                        :

                        * When `feature.type` is `custom`: The value can be any one of `levels[].value`.

                        * When `feature.type` is `switch`: This value is `true` when the feature is available; it is `false` when the feature is unavailable.

                        * When `feature.type` is `quantity`:

                        * When `levels[].is_unlimited` is not `true`: The value can be any one of `levels[].value`.

                        * When `levels[].is_unlimited` is `true`: The value can also be any one of `levels[].value` or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.

                        * When `feature.type` is `range`:

                        * When `levels[].is_unlimited` is not `true`: The value can be any whole number between `levels[0].value` and `levels[1].value` (inclusive).

                        * When `levels[].is_unlimited` is `true`: The value can be any whole number equal to or greater than `levels[0].value` or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.

                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    is_enabled:
                      type: array
                      description: |
                        Specifies whether the entitlement for the feature is enabled (`true`) or disabled (`false`) for the entity on the quote.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    start_date:
                      type: array
                      description: |
                        Start date (UTC timestamp) of the entitlement override for the item on the quote. Used with `end_date` for ramp-scoped entitlements.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    end_date:
                      type: array
                      description: |
                        End date (UTC timestamp) of the entitlement override for the item on the quote. Used with `start_date` for ramp-scoped entitlements.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              billing_address:
                style: deepObject
                explode: true
              contract_term:
                style: deepObject
                explode: true
              coupons:
                style: deepObject
                explode: true
              customer:
                style: deepObject
                explode: true
              discounts:
                style: deepObject
                explode: true
              entitlement_overrides:
                style: deepObject
                explode: true
              item_tiers:
                style: deepObject
                explode: true
              shipping_address:
                style: deepObject
                explode: true
              subscription:
                style: deepObject
                explode: true
              subscription_items:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  quote:
                    $ref: "#/components/schemas/Quote"
                    description: |
                      Resource object representing quote
                  quoted_subscription:
                    $ref: "#/components/schemas/QuotedSubscription"
                    description: |
                      Resource object representing quoted_subscription
                  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}/quote_line_groups:
    get:
      tags:
      - quotes
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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_for_charge_items_and_charges:
    post:
      tags:
      - quotes
      summary: Edit a quote for charges and charge items
      description: |
        Changes the quote produced for adding one-time charges and charge items.
      operationId: edit_quote_for_charge_items_and_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
                net_term_days:
                  type: integer
                  format: int32
                  deprecated: false
                  description: "The number of days within which the customer has to\
                    \ make payment for the invoice.  \n**Note**\n\nThe parameter applies\
                    \ only when Chargebee CPQ is enabled. To request access, contact\
                    \ [Chargebee Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team).\n"
                  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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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
                    country:
                      type: string
                      deprecated: false
                      description: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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
                item_prices:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_prices
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        A unique ID for your system to identify the item price.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Item price quantity
                      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 item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        The price or per-unit-price of the item price. By default, it is the [value set](/docs/api/item_prices/item_price-object#price)
                        for the `item_price`.
                        This is only applicable when the `pricing_model`
                        of the `item_price`
                        is `flat_fee`
                        or `per_unit`.
                        The value depends on the [type of currency](/docs/api/getting-started)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      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/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    service_period_days:
                      type: array
                      description: |
                        Defines service period of the item in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 730
                        minimum: 1
                        example: null
                      example: null
                  example: null
                item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_tiers
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The id of the item price to which this tier belongs.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: |
                        The lowest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The highest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |
                        The per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        The total cost for the item price when the `pricing_model`
                        is `stairstep`.
                        The value is in the minor unit of the currency.
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    pricing_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Pricing type for the tier.

                          * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                          * flat_fee -
                            Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                            pricing model, `pricing_type`
                            will be set to `flat_fee`
                            by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                          * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                        enum:
                        - per_unit
                        - flat_fee
                        - package
                        example: null
                      example: null
                    package_size:
                      type: array
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        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
                discounts:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for discounts
                  properties:
                    percentage:
                      type: array
                      description: |
                        The percentage of the original amount that should be deducted from it.
                      items:
                        type: number
                        format: double
                        deprecated: false
                        maximum: 100
                        minimum: 0.01
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Specifies the number of free units provided for the item, without affecting the total quantity sold
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        The value of the discount. [The format of this value](/docs/api/currencies)
                        depends on the kind of currency.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    apply_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The amount on the quote to which the discount is applied.

                          * invoice_amount -
                            The discount is applied to the invoice `sub_total`
                            .
                          * specific_item_price -
                            The discount is applied to the `invoice.line_item.amount`
                            that corresponds to the item price specified by `item_price_id`
                            .
                        enum:
                        - invoice_amount
                        - specific_item_price
                        example: null
                      example: null
                    item_price_id:
                      type: array
                      description: |
                        The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                        in the subscription to which the discount is to be applied. Relevant only when `apply_on`
                        = `specific_item_price`.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                  required:
                  - apply_on
                  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
              example: null
            encoding:
              billing_address:
                style: deepObject
                explode: true
              charges:
                style: deepObject
                explode: true
              discounts:
                style: deepObject
                explode: true
              item_prices:
                style: deepObject
                explode: true
              item_tiers:
                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: |
                      Resource object representing quote
                  quoted_charge:
                    $ref: "#/components/schemas/QuotedCharge"
                    description: |
                      Resource object representing quoted_charge
                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}/pdf:
    post:
      tags:
      - quotes
      summary: Retrieve a 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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing download
                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/create_for_charge_items_and_charges:
    post:
      tags:
      - quotes
      summary: Create a quote for charges and charge items
      description: |
        Creates a quote using charge-items and one-time charges.
      operationId: create_a_quote_for_charge_and_charge_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
                net_term_days:
                  type: integer
                  format: int32
                  deprecated: false
                  description: "The number of days from [`invoice.date`](/docs/api/invoices/invoice-object#date)\
                    \ until payment for the invoice is due.  \n**Prerequisite**\n\
                    You can use this parameter only when Chargebee CPQ is enabled.\
                    \ Contact [Chargebee Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team)\
                    \ to request access.\n"
                  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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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
                    country:
                      type: string
                      deprecated: false
                      description: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ). For Dubai (UAE), set as `DU`
                        (not `AE-DU`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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
                item_prices:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_prices
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        A unique ID for your system to identify the item price.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Item price quantity
                      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 item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        The price or per-unit-price of the item price. By default, it is the [value set](/docs/api/item_prices/item_price-object#price)
                        for the `item_price`.
                        This is only applicable when the `pricing_model`
                        of the `item_price`
                        is `flat_fee`
                        or `per_unit`.
                        The value depends on the [type of currency](/docs/api/getting-started)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      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/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    service_period_days:
                      type: array
                      description: |
                        Defines service period of the item in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 730
                        minimum: 1
                        example: null
                      example: null
                  example: null
                item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_tiers
                  properties:
                    item_price_id:
                      type: array
                      description: |
                        The id of the item price to which this tier belongs.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: |
                        The lowest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The highest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |
                        The per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        The total cost for the item price when the `pricing_model`
                        is `stairstep`.
                        The value is in the minor unit of the currency.
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    pricing_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Pricing type for the tier.

                          * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                          * flat_fee -
                            Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                            pricing model, `pricing_type`
                            will be set to `flat_fee`
                            by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                          * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                        enum:
                        - per_unit
                        - flat_fee
                        - package
                        example: null
                      example: null
                    package_size:
                      type: array
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        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
                discounts:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for discounts
                  properties:
                    percentage:
                      type: array
                      description: |
                        The percentage of the original amount that should be deducted from it.
                      items:
                        type: number
                        format: double
                        deprecated: false
                        maximum: 100
                        minimum: 0.01
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Specifies the number of free units provided for the item, without affecting the total quantity sold
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        The value of the discount. [The format of this value](/docs/api/currencies)
                        depends on the kind of currency.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    apply_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The amount on the quote to which the discount is applied.

                          * invoice_amount -
                            The discount is applied to the invoice `sub_total`
                            .
                          * specific_item_price -
                            The discount is applied to the `invoice.line_item.amount`
                            that corresponds to the item price specified by `item_price_id`
                            .
                        enum:
                        - invoice_amount
                        - specific_item_price
                        example: null
                      example: null
                    item_price_id:
                      type: array
                      description: |
                        The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                        in the subscription to which the discount is to be applied. Relevant only when `apply_on`
                        = `specific_item_price`.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                  required:
                  - apply_on
                  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
              required:
              - customer_id
              example: null
            encoding:
              billing_address:
                style: deepObject
                explode: true
              charges:
                style: deepObject
                explode: true
              discounts:
                style: deepObject
                explode: true
              item_prices:
                style: deepObject
                explode: true
              item_tiers:
                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: |
                      Resource object representing quote
                  quoted_charge:
                    $ref: "#/components/schemas/QuotedCharge"
                    description: |
                      Resource object representing quoted_charge
                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_entitlements:
    get:
      tags:
      - quotes
      summary: List Quote Entitlements
      description: |
        Retrieves the list of `quote_entitlements` for the [quote](/docs/api/quotes).
      operationId: list_quote_entitlements
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: entity_id
        in: query
        description: |
          Filter quote entitlements by `entity_id`.
          **Supported operators :**
          is

          **Example →**
          *entity_id\[is\] = "price-usd"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            is:
              type: string
              minLength: 1
              example: null
          example: null
      - name: start_date
        in: query
        description: |
          Filter entitlements by ramp start date (unix timestamp). Use with `end_date[on]`.
          **Supported operators :**
          on

          **Example →**
          *start_date\[on\] = "1780252200"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1780252200"
          properties:
            "on":
              type: string
              format: unix-time
              pattern: "^\\d{10}$"
              example: null
      - name: end_date
        in: query
        description: |
          Filter entitlements by ramp end date (unix timestamp). Use with `start_date[on]`.
          **Supported operators :**
          on

          **Example →**
          *end_date\[on\] = "1782844200"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1782844200"
          properties:
            "on":
              type: string
              format: unix-time
              pattern: "^\\d{10}$"
              example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        quote_entitlement:
                          $ref: "#/components/schemas/QuoteEntitlement"
                          description: Resource object representing quote_entitlement
                      required:
                      - quote_entitlement
                      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: []
  /coupons:
    get:
      tags:
      - coupons
      summary: List coupons
      description: |
        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.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: id
        in: query
        description: "optional, string filter\n\nUsed to uniquely identify the coupon\
          \ in your website/application and to integrate with Chargebee.  \n**Note:**\n\
          \nWhen the coupon ID contains a special character; for example: `#`, the\
          \ API returns an error. Make sure that you [encode](https://www.urlencoder.org/)\
          \ the coupon ID in the path parameter before making an API call.\n\n.\n\
          **Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example\
          \ →**\n*id\\[is\\] = \"OFF2008\"*\n"
        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: "optional, string filter\n\nThe display name used in web interface\
          \ for identifying the coupon.  \n**Note:**\n\nWhen the name of the coupon\
          \ set contains a special character; for example: `#`, the API returns an\
          \ error. Make sure that you [encode](https://www.urlencoder.org/) the name\
          \ of the coupon set in the path parameter before making an API call.\n\n\
          .\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example\
          \ →**\n*name\\[is_not\\] = \"Offer 10\"*\n"
        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 **once**. It is removed after that from the subscription.
                * `forever` - The coupon is attached to the subscription and applied on the invoices until explicitly removed.
                * `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 `period` and `period_unit`.
              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 **once**. It is removed after that from the subscription.
                * `forever` - The coupon is attached to the subscription and applied on the invoices until explicitly removed.
                * `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 `period` and `period_unit`.
              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 **once**. It is removed after that from the subscription.
                * `forever` - The coupon is attached to the subscription and applied on the invoices until explicitly removed.
                * `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 `period` and `period_unit`.
              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 **once**. It is removed after that from the subscription.
                * `forever` - The coupon is attached to the subscription and applied on the invoices until explicitly removed.
                * `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 `period` and `period_unit`.
              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_not\] = "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 [max_redemptions](/docs/api/coupons?#coupon_max_redemptions) or [valid_till](/docs/api/coupons?#coupon_valid_till) 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.
                * `future` - The coupon is scheduled to start at a future date and cannot be applied to a subscription. From the valid_from date, the status changes to active.
              enum:
              - active
              - expired
              - archived
              - deleted
              - future
              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 [max_redemptions](/docs/api/coupons?#coupon_max_redemptions) or [valid_till](/docs/api/coupons?#coupon_valid_till) 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.
                * `future` - The coupon is scheduled to start at a future date and cannot be applied to a subscription. From the valid_from date, the status changes to active.
              enum:
              - active
              - expired
              - archived
              - deleted
              - future
              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 [max_redemptions](/docs/api/coupons?#coupon_max_redemptions) or [valid_till](/docs/api/coupons?#coupon_valid_till) 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.
                * `future` - The coupon is scheduled to start at a future date and cannot be applied to a subscription. From the valid_from date, the status changes to active.
              enum:
              - active
              - expired
              - archived
              - deleted
              - future
              pattern: "^\\[(active|expired|archived|deleted|future)(,(active|expired|archived|deleted|future))*\\\
                ]$"
              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 [max_redemptions](/docs/api/coupons?#coupon_max_redemptions) or [valid_till](/docs/api/coupons?#coupon_valid_till) 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.
                * `future` - The coupon is scheduled to start at a future date and cannot be applied to a subscription. From the valid_from date, the status changes to active.
              enum:
              - active
              - expired
              - archived
              - deleted
              - future
              pattern: "^\\[(active|expired|archived|deleted|future)(,(active|expired|archived|deleted|future))*\\\
                ]$"
              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\
                \ `sub_total`.\n* `specified_items_total` - **(Deprecated)** Discount\
                \ will be applied to the total of plan and addon items specified.\n\
                * `each_specified_item` -\n  The coupon is applied to the `invoice.line_item.amount`\
                \ that corresponds to the item price specified by `item_price_id`.\
                \  \n  The coupon is applied to the `invoice.line_item.amount` that\
                \ corresponds to the plan or addon specified by `plan_ids` and `addon_ids`.\n\
                * `each_unit_of_specified_items` - **(Deprecated)** Discount will\
                \ be applied to each unit of plan and addon items specified.\n"
              enum:
              - invoice_amount
              - each_specified_item
              example: null
            is_not:
              type: string
              description: "* `invoice_amount` - The coupon is applied to the invoice\
                \ `sub_total`.\n* `specified_items_total` - **(Deprecated)** Discount\
                \ will be applied to the total of plan and addon items specified.\n\
                * `each_specified_item` -\n  The coupon is applied to the `invoice.line_item.amount`\
                \ that corresponds to the item price specified by `item_price_id`.\
                \  \n  The coupon is applied to the `invoice.line_item.amount` that\
                \ corresponds to the plan or addon specified by `plan_ids` and `addon_ids`.\n\
                * `each_unit_of_specified_items` - **(Deprecated)** Discount will\
                \ be applied to each unit of plan and addon items specified.\n"
              enum:
              - invoice_amount
              - each_specified_item
              example: null
            in:
              type: string
              description: "* `invoice_amount` - The coupon is applied to the invoice\
                \ `sub_total`.\n* `specified_items_total` - **(Deprecated)** Discount\
                \ will be applied to the total of plan and addon items specified.\n\
                * `each_specified_item` -\n  The coupon is applied to the `invoice.line_item.amount`\
                \ that corresponds to the item price specified by `item_price_id`.\
                \  \n  The coupon is applied to the `invoice.line_item.amount` that\
                \ corresponds to the plan or addon specified by `plan_ids` and `addon_ids`.\n\
                * `each_unit_of_specified_items` - **(Deprecated)** Discount will\
                \ be applied to each unit of plan and addon items specified.\n"
              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\
                \ `sub_total`.\n* `specified_items_total` - **(Deprecated)** Discount\
                \ will be applied to the total of plan and addon items specified.\n\
                * `each_specified_item` -\n  The coupon is applied to the `invoice.line_item.amount`\
                \ that corresponds to the item price specified by `item_price_id`.\
                \  \n  The coupon is applied to the `invoice.line_item.amount` that\
                \ corresponds to the plan or addon specified by `plan_ids` and `addon_ids`.\n\
                * `each_unit_of_specified_items` - **(Deprecated)** Discount will\
                \ be applied to each unit of plan and addon items specified.\n"
              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\[before\] = "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\[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: 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
        description: |
          optional, string filter

          List of itemPrice ids for which these coupons are applicable.

          **Supported operators :**
          in, is

          **Example →**
          *applicable_item_price_ids\[is\] = "day-pass-USD"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: day-pass-USD
          properties:
            in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
            is:
              type: string
              minLength: 1
              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: []
  /coupons/{coupon-id}/update_for_items:
    post:
      tags:
      - coupons
      summary: Update a coupon for items
      description: |
        This API updates a coupon that is created for a specific promotion or offers.
      operationId: update_a_coupon_for_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
              additionalProperties: true
              properties:
                name:
                  type: string
                  deprecated: false
                  description: "The display name used in web interface for identifying\
                    \ the coupon.  \n**Note:**\n\nWhen the name of the coupon set\
                    \ contains a special character; for example: `#`, the API returns\
                    \ an error. Make sure that you [encode](https://www.urlencoder.org/)\
                    \ the name of the coupon set in the path parameter before making\
                    \ an API call.\n\n.\n"
                  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: "Specifies the type of discount to be applied.\n\n\
                    * percentage -\n  A percentage of the original price is deducted\
                    \ as a discount. The discount percentage is specified in [discount_percentage](/docs/api/coupons/update-a-coupon-for-items#discount_percentage).\
                    \  \n  [Learn more](https://www.chargebee.com/docs/2.0/coupons.html#percentage-coupons)\n\
                    \  about `percentage`\n  coupons.\n* fixed_amount -\n  A fixed\
                    \ amount is deducted as a discount. The discount amount is specified\
                    \ in [discount_amount](/docs/api/coupons/update-a-coupon-for-items#discount_amount).\
                    \  \n  [Learn more](https://www.chargebee.com/docs/2.0/coupons.html#fixed-amount-coupons)\n\
                    \  about `fixed_amount`\n  coupons.\n* offer_quantity -\n  A specified\
                    \ number of units of the item price are offered for free. The\
                    \ number of free units is specified in [discount_quantity](/docs/api/coupons/update-a-coupon-for-items#discount_quantity).\n\
                    \  The `offer_quantity`\n  option is valid only when [apply_on](/docs/api/coupons/update-a-coupon-for-items#apply_on)\n\
                    \  is set to `each_specified_item`\n  and the [pricing_model](/docs/api/item_prices/item_price-object#pricing_model)\n\
                    \  of the item price is `per_unit`.  \n  [Learn more](https://www.chargebee.com/docs/2.0/coupons.html#offer-quantity-coupons)\n\
                    \  about `offer_quantity`\n  coupons.\n"
                  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: |
                    Specifies the number of free units provided for the [item price](/docs/api/item_prices)
                    , without affecting the total quantity sold. This parameter is applicable only when the [discount_type](/docs/api/coupons/update-a-coupon-for-items#discount_type)
                    is set to `offer_quantity`
                    .
                  minimum: 1
                  example: null
                apply_on:
                  type: string
                  deprecated: false
                  description: |
                    The amount on the invoice to which the coupon is applied.

                    * invoice_amount -
                      The coupon is applied to the invoice `sub_total`
                      .
                    * each_specified_item -
                      Applies the coupon to specified items (plans, addons, or charges), with the discount applied to each matching `invoice.line_item.amount`.

                      Requires applicability to be configured using [`item_constraints`](/docs/api/coupons/update-a-coupon-for-items#item_constraints)---for example `all`, `criteria`, or `specific` with `item_price_ids`.

                      When you attach this coupon to a subscription, at least one of that subscription's plans, addons, or charges must match those rules. If none do, the request fails.
                  enum:
                  - invoice_amount
                  - each_specified_item
                  example: null
                duration_type:
                  type: string
                  default: forever
                  deprecated: false
                  description: |
                    Specifies the time duration for which this coupon is attached to the subscription.

                    * forever - The coupon is attached to the subscription and applied on the invoices until explicitly removed.
                    * one_time -
                      The coupon stays attached to the subscription till it is applied on an invoice **once**.
                      It is removed after that from the subscription.
                    * 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 `period`
                      and `period_unit`
                      .
                  enum:
                  - one_time
                  - forever
                  - limited_period
                  example: null
                duration_month:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    **(Deprecated)**
                    The duration of time in months for which the coupon is attached to the subscription. Applicable only when `duration_type`
                    is `limited_period`.

                    **Note:**
                    This parameter has been deprecated. Use `period`
                    and `period_unit`
                    instead.
                  maximum: 240
                  minimum: 1
                  example: null
                valid_from:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The date from which the coupon can be applied to subscriptions.
                  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.  \n**Note:**\nThere's a character\
                    \ limit of 65,535.\n\n[Learn more](/docs/api/advanced-features)\n\
                    .\n"
                  example: null
                included_in_mrr:
                  type: boolean
                  deprecated: false
                  description: |
                    The coupon is included in MRR calculations for your site. This attribute is only applicable for coupons of `duration_type = one_time`
                    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 `false`
                    .
                  example: null
                period:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The duration of time for which the coupon is attached to the subscription, in `period_units`.
                    Applicable only when [duration_type](/docs/api/coupons/coupon-object#duration_type)
                    is [limited_period](/docs/api/coupons/coupon-object#duration_type)
                    .
                  minimum: 1
                  example: null
                period_unit:
                  type: string
                  deprecated: false
                  description: |
                    The unit of time for period. Applicable only when [duration_type](/docs/api/coupons/coupon-object#duration_type)
                    is [limited_period](/docs/api/coupons/coupon-object#duration_type)
                    .

                    * month - A period of 1 calendar month.
                    * week - A period of 7 days.
                    * year - A period of 1 calendar year.
                    * day - A period of 24 hours.
                  enum:
                  - day
                  - week
                  - month
                  - year
                  example: null
                item_constraints:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_constraints
                  properties:
                    constraint:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Constraint applicable for the item

                          * specific - Coupon applicable to specific items.
                          * all - Coupon applicable to all items.
                          * criteria - Coupon applicable based on criteria.
                          * none - Coupon not applicable to any items.
                        enum:
                        - none
                        - all
                        - specific
                        - criteria
                        example: null
                      example: null
                    item_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Item type for which this criteria is applicable for.

                          * charge - Charge
                          * plan - Plan
                          * addon - Addon
                        enum:
                        - plan
                        - addon
                        - charge
                        example: null
                      example: null
                    item_price_ids:
                      type: array
                      description: "List of item price ids for which this coupon is\
                        \ applicable.  \n**Note:**\n\nWhen specifying a value for\
                        \ `item_price_ids`, make sure that the value is wrapped in\
                        \ square brackets (`[]`), for example: `[cbdemo_advanced-USD-Daily]`\
                        \ instead of `cbdemo_advanced-USD-Daily`; otherwise, a `param_wrong_value`\
                        \ error returns.\n\nFor information about `item_price_ids`,\
                        \ refer to *Defining Price Points* in [Plans](https://www.chargebee.com/docs/2.0/plans.html#defining-price-points-for-plan),\
                        \ [Addons](https://www.chargebee.com/docs/2.0/addons.html#defining-price-points-for-an-addon),\
                        \ and [Charges](https://www.chargebee.com/docs/2.0/charges.html#defining-price-points-for-a-charge).\n"
                      items:
                        type: array
                        deprecated: false
                        items:
                          example: null
                        example: null
                      example: null
                  required:
                  - constraint
                  - item_type
                  example: null
                item_constraint_criteria:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_constraint_criteria
                  properties:
                    item_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Item type for which this criteria is applicable for.

                          * charge - Charge is a type of item
                          * plan - Plan is a type of item
                          * addon - Addon is a type of item
                        enum:
                        - plan
                        - addon
                        - charge
                        example: null
                      example: null
                    item_family_ids:
                      type: array
                      description: |
                        List of families for which this coupon is applicable.
                      items:
                        type: array
                        deprecated: false
                        items:
                          example: null
                        example: null
                      example: null
                    currencies:
                      type: array
                      description: |
                        List of currencies ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)
                        ) for which this coupon is applicable.
                      items:
                        type: array
                        deprecated: false
                        items:
                          example: null
                        example: null
                      example: null
                    item_price_periods:
                      type: array
                      description: |
                        Pass the item price period units for this criterion. `period`
                        followed by `period_units`.
                        Such as `[1 day,1 week,3 month,6 month]`
                      items:
                        type: array
                        deprecated: false
                        items:
                          example: null
                        example: null
                      example: null
                  example: null
                coupon_constraints:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for `coupon_constraints`.
                    Multiple `coupon_constraints`
                    can be passed by specifying unique indices.
                  properties:
                    entity_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The resource type for the constraint. This, along with `type`
                          and `value`
                          , helps define the specific rule applied.

                          * customer -
                            The constraint is based on `customer`
                            records.
                        enum:
                        - customer
                        example: null
                      example: null
                    type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The type of coupon constraint.

                          * unique_by -
                            Indicates - when `entity_type`
                            is `customer`

                            * that the coupon can be redeemed only once for every unique value of a specified `customer` attribute. The `customer` attribute is specified using `value`. For example, if `value` is `email` , then the coupon can be redeemed only once for every unique value of `customer.email`. In other words, when there are multiple `customer` records with the same value for `email` , once the coupon has been redeemed for one of those customer records, no further redemptions of the coupon are allowed for any of those `customer` records.
                          * new_customer -
                            The coupon is applicable only for new customer(s). A customer will be considered as `new_customer`
                            when they do not have any prior non-void, non-zero-dollar invoices.
                          * existing_customer -
                            The coupon is applicable only for existing customer(s). A customer will be considered as `existing_customer`
                            when they have at least one non-void, non-zero-dollar invoice.
                          * max_redemptions -
                            The coupon can be redeemed up to a set number of times for a specific resource type. The maximum redemptions are specified using `value`
                            , and the resource type is specified using `entity_type`.
                            For example, if `entity_type`
                            is `customer`
                            and `value`
                            is `10`
                            then the coupon can only be redeemed up to 10 times for any particular `customer`
                            record.
                        enum:
                        - max_redemptions
                        - unique_by
                        - existing_customer
                        - new_customer
                        example: null
                      example: null
                    value:
                      type: array
                      description: |+
                        The value of the coupon constraint. The possible values depend on the value of `constraints[type]`:

                        * When `type` is `unique_by`, then `value` can be `email` or `id`.

                        * When `type` is `max_redemptions`, then `value` can be any integer in the range `1` `coupon.max_redemptions`, inclusive.

                        * When type is `new_customer` or `existing_customer` then `value` can be `based_on_invoice`.

                      items:
                        type: string
                        deprecated: false
                        maxLength: 65000
                        example: null
                      example: null
                  required:
                  - entity_type
                  - type
                  example: null
              example: null
            encoding:
              coupon_constraints:
                style: deepObject
                explode: true
              item_constraint_criteria:
                style: deepObject
                explode: true
              item_constraints:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  coupon:
                    $ref: "#/components/schemas/Coupon"
                    description: |
                      Resource object representing coupon
                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:
      tags:
      - coupons
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing coupon
                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:
      tags:
      - coupons
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing coupon
                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:
      tags:
      - coupons
      summary: Copy a coupon
      description: |
        Copies a coupon over from one site to another. Copying of [archived](/docs/api/coupons/coupon-object#status) coupons is not supported.

        The item prices that are linked to the coupon in the source site are also linked to the coupon in the destination site. However, this will only work if those item prices exist and with the same [ids](/docs/api/item_prices/item_price-object#id), in the destination site. Hence, it is recommended that the item prices be copied over before copying the coupons.

        The value for [redemptions](/docs/api/coupons/coupon-object#redemptions) is not copied. It is set to `0` for the newly created coupon. Hence, if such a coupon had `expired` in the source site due to `redemptions` having reached [max_redemptions](/docs/api/coupons/coupon-object#max_redemptions), it's [status](/docs/api/coupons/coupon-object#status) would be `active` in the destination site.
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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, redemptions, 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: |
                      Resource object representing coupon
                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:
      tags:
      - coupons
      summary: Retrieve a coupon
      description: |
        This API retrieves a specific coupon using the coupon ID.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing coupon
                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/create_for_items:
    post:
      tags:
      - coupons
      summary: Create a coupon for items
      description: |
        This API creates a new coupon for a specific promotion or offers.
      operationId: create_a_coupon_for_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
              properties:
                id:
                  type: string
                  deprecated: false
                  description: "Used to uniquely identify the coupon in your website/application\
                    \ and to integrate with Chargebee.  \n**Note:**\n\nWhen the coupon\
                    \ ID contains a special character; for example: `#`, the API returns\
                    \ an error. Make sure that you [encode](https://www.urlencoder.org/)\
                    \ the coupon ID in the path parameter before making an API call.\n\
                    \n.\n"
                  maxLength: 100
                  example: null
                name:
                  type: string
                  deprecated: false
                  description: "The display name used in web interface for identifying\
                    \ the coupon.  \n**Note:**\n\nWhen the name of the coupon set\
                    \ contains a special character; for example: `#`, the API returns\
                    \ an error. Make sure that you [encode](https://www.urlencoder.org/)\
                    \ the name of the coupon set in the path parameter before making\
                    \ an API call.\n\n.\n"
                  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: "Specifies the type of discount to be applied.\n\n\
                    * percentage -\n  A percentage of the original price is deducted\
                    \ as a discount. The discount percentage is specified in [discount_percentage](/docs/api/coupons/create-a-coupon-for-items#discount_percentage).\
                    \  \n  [Learn more](https://www.chargebee.com/docs/2.0/coupons.html#percentage-coupons)\n\
                    \  about `percentage`\n  coupons.\n* fixed_amount -\n  A fixed\
                    \ amount is deducted as a discount. The discount amount is specified\
                    \ in [discount_amount](/docs/api/coupons/create-a-coupon-for-items#discount_amount).\
                    \  \n  [Learn more](https://www.chargebee.com/docs/2.0/coupons.html#fixed-amount-coupons)\n\
                    \  about `fixed_amount`\n  coupons.\n* offer_quantity -\n  A specified\
                    \ number of units of the item price are offered for free. The\
                    \ number of free units is specified in [discount_quantity](/docs/api/coupons/create-a-coupon-for-items#discount_quantity).\n\
                    \  The `offer_quantity`\n  option is valid only when [apply_on](/docs/api/coupons/create-a-coupon-for-items#apply_on)\n\
                    \  is set to `each_specified_item`\n  and the [pricing_model](/docs/api/item_prices/item_price-object#pricing_model)\n\
                    \  of the item price is `per_unit`.  \n  [Learn more](https://www.chargebee.com/docs/2.0/coupons.html#offer-quantity-coupons)\n\
                    \  about `offer_quantity`\n  coupons.\n"
                  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: |
                    Specifies the number of free units provided for the [item price](/docs/api/item_prices)
                    , without affecting the total quantity sold. This parameter is applicable only when the [discount_type](/docs/api/coupons/create-a-coupon-for-items#discount_type)
                    is set to `offer_quantity`
                    .
                  minimum: 1
                  example: null
                apply_on:
                  type: string
                  deprecated: false
                  description: |
                    The amount on the invoice to which the coupon is applied.

                    * invoice_amount -
                      The coupon is applied to the invoice `sub_total`
                      .
                    * each_specified_item -
                      Applies the coupon to specified items (plans, addons, or charges), with the discount applied to each matching `invoice.line_item.amount`.

                      Requires applicability to be configured using [`item_constraints`](/docs/api/coupons/create-a-coupon-for-items#item_constraints)---for example `all`, `criteria`, or `specific` with `item_price_ids`.

                      When you attach this coupon to a subscription, at least one of that subscription's plans, addons, or charges must match those rules. If none do, the request fails.
                  enum:
                  - invoice_amount
                  - each_specified_item
                  example: null
                duration_type:
                  type: string
                  default: forever
                  deprecated: false
                  description: |
                    Specifies the time duration for which this coupon is attached to the subscription.

                    * forever - The coupon is attached to the subscription and applied on the invoices until explicitly removed.
                    * one_time -
                      The coupon stays attached to the subscription till it is applied on an invoice **once**.
                      It is removed after that from the subscription.
                    * 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 `period`
                      and `period_unit`
                      .
                  enum:
                  - one_time
                  - forever
                  - limited_period
                  example: null
                duration_month:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    **(Deprecated)**
                    The duration of time in months for which the coupon is attached to the subscription. Applicable only when `duration_type`
                    is `limited_period`.

                    **Note:**
                    This parameter has been deprecated. Use `period`
                    and `period_unit`
                    instead.
                  maximum: 240
                  minimum: 1
                  example: null
                valid_from:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The date from which the coupon can be applied to subscriptions.
                  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.  \n**Note:**\nThere's a character\
                    \ limit of 65,535.\n\n[Learn more](/docs/api/advanced-features)\n\
                    .\n"
                  example: null
                included_in_mrr:
                  type: boolean
                  deprecated: false
                  description: |
                    The coupon is included in MRR calculations for your site. This attribute is only applicable for coupons of `duration_type = one_time`
                    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 `false`
                    .
                  example: null
                period:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The duration of time for which the coupon is attached to the subscription, in `period_units`.
                    Applicable only when [duration_type](/docs/api/coupons/coupon-object#duration_type)
                    is [limited_period](/docs/api/coupons/coupon-object#duration_type)
                    .
                  minimum: 1
                  example: null
                period_unit:
                  type: string
                  deprecated: false
                  description: |
                    The unit of time for period. Applicable only when [duration_type](/docs/api/coupons/coupon-object#duration_type)
                    is [limited_period](/docs/api/coupons/coupon-object#duration_type)
                    .

                    * month - A period of 1 calendar month.
                    * week - A period of 7 days.
                    * year - A period of 1 calendar year.
                    * day - A period of 24 hours.
                  enum:
                  - day
                  - week
                  - month
                  - year
                  example: null
                status:
                  type: string
                  default: active
                  deprecated: false
                  description: |
                    Status of the coupon.

                    * archived - Cannot be applied to a subscription. Existing associations remain unaffected.
                    * active - Can be applied to a subscription.
                  enum:
                  - active
                  - archived
                  example: null
                item_constraints:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_constraints
                  properties:
                    constraint:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Constraint applicable for the item

                          * specific - Coupon applicable to specific items.
                          * all - Coupon applicable to all items.
                          * criteria - Coupon applicable based on criteria.
                          * none - Coupon not applicable to any items.
                        enum:
                        - none
                        - all
                        - specific
                        - criteria
                        example: null
                      example: null
                    item_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Item type for which this criteria is applicable for.

                          * charge - Charge
                          * plan - Plan
                          * addon - Addon
                        enum:
                        - plan
                        - addon
                        - charge
                        example: null
                      example: null
                    item_price_ids:
                      type: array
                      description: "List of item price ids for which this coupon is\
                        \ applicable.  \n**Note:**\n\nWhen specifying a value for\
                        \ `item_price_ids`, make sure that the value is wrapped in\
                        \ square brackets (`[]`), for example: `[cbdemo_advanced-USD-Daily]`\
                        \ instead of `cbdemo_advanced-USD-Daily`; otherwise, a `param_wrong_value`\
                        \ error returns.\n\nFor information about `item_price_ids`,\
                        \ refer to *Defining Price Points* in [Plans](https://www.chargebee.com/docs/2.0/plans.html#defining-price-points-for-plan),\
                        \ [Addons](https://www.chargebee.com/docs/2.0/addons.html#defining-price-points-for-an-addon),\
                        \ and [Charges](https://www.chargebee.com/docs/2.0/charges.html#defining-price-points-for-a-charge).\n"
                      items:
                        type: array
                        deprecated: false
                        items:
                          example: null
                        example: null
                      example: null
                  required:
                  - constraint
                  - item_type
                  example: null
                item_constraint_criteria:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_constraint_criteria
                  properties:
                    item_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Item type for which this criteria is applicable for.

                          * charge - Charge is a type of item
                          * plan - Plan is a type of item
                          * addon - Addon is a type of item
                        enum:
                        - plan
                        - addon
                        - charge
                        example: null
                      example: null
                    item_family_ids:
                      type: array
                      description: |
                        List of families for which this coupon is applicable.
                      items:
                        type: array
                        deprecated: false
                        items:
                          example: null
                        example: null
                      example: null
                    currencies:
                      type: array
                      description: |
                        List of currencies ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)
                        ) for which this coupon is applicable.
                      items:
                        type: array
                        deprecated: false
                        items:
                          example: null
                        example: null
                      example: null
                    item_price_periods:
                      type: array
                      description: |
                        Pass the item price period units for this criterion. `period`
                        followed by `period_units`.
                        Such as `[1 day,1 week,3 month,6 month]`
                      items:
                        type: array
                        deprecated: false
                        items:
                          example: null
                        example: null
                      example: null
                  example: null
                coupon_constraints:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for `coupon_constraints`.
                    Multiple `coupon_constraints`
                    can be passed by specifying unique indices.
                  properties:
                    entity_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The resource type for the constraint. This, along with `type`
                          and `value`
                          , helps define the specific rule applied.

                          * customer -
                            The constraint is based on `customer`
                            records.
                        enum:
                        - customer
                        example: null
                      example: null
                    type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The type of coupon constraint.

                          * unique_by -
                            Indicates - when `entity_type`
                            is `customer`

                            * that the coupon can be redeemed only once for every unique value of a specified `customer` attribute. The `customer` attribute is specified using `value`. For example, if `value` is `email` , then the coupon can be redeemed only once for every unique value of `customer.email`. In other words, when there are multiple `customer` records with the same value for `email` , once the coupon has been redeemed for one of those customer records, no further redemptions of the coupon are allowed for any of those `customer` records.
                          * new_customer -
                            The coupon is applicable only for new customer(s). A customer will be considered as `new_customer`
                            when they do not have any prior non-void, non-zero-dollar invoices.
                          * existing_customer -
                            The coupon is applicable only for existing customer(s). A customer will be considered as `existing_customer`
                            when they have at least one non-void, non-zero-dollar invoice.
                          * max_redemptions -
                            The coupon can be redeemed up to a set number of times for a specific resource type. The maximum redemptions are specified using `value`
                            , and the resource type is specified using `entity_type`.
                            For example, if `entity_type`
                            is `customer`
                            and `value`
                            is `10`
                            then the coupon can only be redeemed up to 10 times for any particular `customer`
                            record.
                        enum:
                        - max_redemptions
                        - unique_by
                        - existing_customer
                        - new_customer
                        example: null
                      example: null
                    value:
                      type: array
                      description: |+
                        The value of the coupon constraint. The possible values depend on the value of `constraints[type]`:

                        * When `type` is `unique_by`, then `value` can be `email` or `id`.

                        * When `type` is `max_redemptions`, then `value` can be any integer in the range `1` `coupon.max_redemptions`, inclusive.

                        * When type is `new_customer` or `existing_customer` then `value` can be `based_on_invoice`.

                      items:
                        type: string
                        deprecated: false
                        maxLength: 65000
                        example: null
                      example: null
                  required:
                  - entity_type
                  - type
                  example: null
              required:
              - apply_on
              - id
              - name
              example: null
            encoding:
              coupon_constraints:
                style: deepObject
                explode: true
              item_constraint_criteria:
                style: deepObject
                explode: true
              item_constraints:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  coupon:
                    $ref: "#/components/schemas/Coupon"
                    description: |
                      Resource object representing coupon
                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:
      tags:
      - coupon_sets
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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_not\] = "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\] = "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\[gt\] = "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\[is\] = "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\[is\] = "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:
      tags:
      - coupon_sets
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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.  \n**Note:**\nThere's a character\
                    \ limit of 65,535.\n\n[Learn more](/docs/api/advanced-features)\n\
                    .\n"
                  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: |
                      Resource object representing coupon_set
                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:
      tags:
      - coupon_sets
      summary: Update a coupon set
      description: |
        Use this API to update a specific coupon set by updating its `name` and the `meta_data`.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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.  \n**Note:**\nThere's a character\
                    \ limit of 65,535.\n\n[Learn more](/docs/api/advanced-features)\n\
                    .\n"
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  coupon_set:
                    $ref: "#/components/schemas/CouponSet"
                    description: |
                      Resource object representing coupon_set
                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:
      tags:
      - coupon_sets
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing coupon_set
                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:
      tags:
      - coupon_sets
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing coupon_set
                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:
      tags:
      - coupon_sets
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing coupon_set
                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:
      tags:
      - coupon_sets
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing coupon_set
                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:
      tags:
      - coupon_codes
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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_not\] = "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:
      tags:
      - coupon_codes
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing coupon_code
                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:
      tags:
      - coupon_codes
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing coupon_code
                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:
      tags:
      - addresses
      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})))?::)))))$"
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  address:
                    $ref: "#/components/schemas/Address"
                    description: |
                      Resource object representing address
                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:
      tags:
      - addresses
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                    without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                    as `AZ`
                    (not `US-AZ`
                    ). For Tamil Nadu (India), set as `TN`
                    (not `IN-TN`
                    ). For British Columbia (Canada), set as `BC`
                    (not `CA-BC`
                    ). For Dubai (UAE), set as `DU`
                    (not `AE-DU`
                    ).
                  maxLength: 50
                  example: null
                state:
                  type: string
                  deprecated: false
                  description: |
                    The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code`
                    is provided.
                  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: "The billing address country of the customer. Must\
                    \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                    .\n\n**Note**:\nIf you enter an invalid country code, the system\
                    \ will return an error.  \n**Brexit**\n\nIf you have enabled [EU\
                    \ VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021 or\
                    \ later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                    \ the Brexit configuration, then `XI` (the code for **United Kingdom\
                    \ - Northern Ireland**) is available as an option.\n\n.\n"
                  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: |
                      Resource object representing address
                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: []
  /usages/pdf:
    post:
      tags:
      - usages
      summary: Retrieve usages for an invoice as PDF
      description: |
        **Advanced Usage-Based Billing**

        For high-scale usage ingestion, use [Advanced Usage-Based Billing](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/understanding-usages) with the [Usage Events API](/docs/api/usage_events). The Usage Events API supports schemaless event ingestion at scale, including [individual events](/docs/api/usage_events/create-a-usage-event), [batch ingestion](/docs/api/usage_events/ingest-usages-in-batch), and [usage file ingestion](/docs/api/usage_files/usage-file-object).

        Retrieves usages record for an invoice in PDF file format. This endpoint is part of the [Usages API](/docs/api/usages) for **Automated Metered Billing**.
      operationId: retrieve_usages_for_an_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
                invoice:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for invoice
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        The invoice number. Acts as a identifier for invoice and typically generated sequentially.
                      maxLength: 50
                      example: null
                  required:
                  - id
                  example: null
              example: null
            encoding:
              invoice:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  download:
                    $ref: "#/components/schemas/Download"
                    description: |
                      Resource object representing download
                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: []
  /subscriptions/{subscription-id}/usages:
    get:
      tags:
      - subscriptions
      summary: Retrieve a usage
      description: |
        **Advanced Usage-Based Billing**

        For high-scale usage ingestion, use [Advanced Usage-Based Billing](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/understanding-usages) with the [Usage Events API](/docs/api/usage_events). The Usage Events API supports schemaless event ingestion at scale, including [individual events](/docs/api/usage_events/create-a-usage-event), [batch ingestion](/docs/api/usage_events/ingest-usages-in-batch), and [usage file ingestion](/docs/api/usage_files/usage-file-object).

        Retrieves a usage record of a specific subscription. This endpoint is part of the [Usages API](/docs/api/usages) for **Automated Metered Billing**.
      operationId: retrieve_a_usage
      parameters:
      - name: id
        in: query
        description: |
          The unique identifier for the usage record to be retrieved.
        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})))?::)))))$"
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
                  usage:
                    $ref: "#/components/schemas/Usage"
                    description: |
                      Resource object representing usage
                required:
                - usage
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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:
      tags:
      - subscriptions
      summary: Create a usage
      description: "**Advanced Usage-Based Billing**\n\nFor high-scale usage ingestion,\
        \ use [Advanced Usage-Based Billing](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/understanding-usages)\
        \ with the [Usage Events API](/docs/api/usage_events). The Usage Events API\
        \ supports schemaless event ingestion at scale, including [individual events](/docs/api/usage_events/create-a-usage-event),\
        \ [batch ingestion](/docs/api/usage_events/ingest-usages-in-batch), and [usage\
        \ file ingestion](/docs/api/usage_files/usage-file-object).\n\nCreates a usage\
        \ record for an item price in a subscription. The item price must belong to\
        \ a [`metered`](/docs/api/items/item-object#metered) item. This endpoint is\
        \ part of the [Usages API](/docs/api/usages) for **Automated Metered Billing**.\
        \  \n**Max Usages**\n\nLegacy metered billing applies per-subscription usage\
        \ limits over the subscription lifetime. [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 the limit applicable to your site or to request an increase. For high-volume\
        \ usage at scale, see [Usage-Based Billing](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/understanding-usages).\n"
      operationId: create_a_usage
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
                id:
                  type: string
                  deprecated: false
                  description: |
                    A unique and immutable id for the usage. If not provided, it is autogenerated.
                  maxLength: 100
                  example: null
                item_price_id:
                  type: string
                  deprecated: false
                  description: |
                    The id of the [item price](/docs/api/item_prices)
                    to which this usage belongs. The item price must be a part of the subscription or should have been part of it historically.
                  maxLength: 100
                  example: null
                quantity:
                  type: string
                  deprecated: false
                  description: |
                    The quantity specified for this usage record.
                  maxLength: 40
                  example: null
                usage_date:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: |
                    The time at which this usage occurred. Chargebee bills only those usages whose
                    `usage_date`
                    falls within a time when the subscription `status`
                    was `active`
                    or `non_renewing`.
                    However, the remaining usage records are still stored and are
                    [retrievable](/docs/api/usages/retrieve-a-usage).

                    **Note:**
                    If `usage_date`
                    corresponds to a time already invoiced, then it is stored but never invoiced unless the [invoice is regenerated](/docs/api/subscriptions/regenerate-an-invoice)
                    .
                  example: null
                note:
                  type: string
                  deprecated: false
                  description: |
                    A note for this usage record. This note is not displayed on any customer-facing document or interface such as [invoice PDFs](/docs/api/invoices/retrieve-invoice-as-pdf)
                    or [Hosted Pages](/docs/api/hosted_pages)
                    .
                  maxLength: 500
                  example: null
              required:
              - item_price_id
              - quantity
              - usage_date
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  usage:
                    $ref: "#/components/schemas/Usage"
                    description: |
                      Resource object representing usage
                required:
                - usage
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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_usage:
    post:
      tags:
      - subscriptions
      summary: Delete a usage
      description: |
        **Advanced Usage-Based Billing**

        For high-scale usage ingestion, use [Advanced Usage-Based Billing](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/understanding-usages) with the [Usage Events API](/docs/api/usage_events). The Usage Events API supports schemaless event ingestion at scale, including [individual events](/docs/api/usage_events/create-a-usage-event), [batch ingestion](/docs/api/usage_events/ingest-usages-in-batch), and [usage file ingestion](/docs/api/usage_files/usage-file-object).

        Deletes a usage record. This operation cannot be invoked for a usage record that has been [invoiced](/docs/api/usages). This endpoint is part of the [Usages API](/docs/api/usages) for **Automated Metered Billing**.
      operationId: delete_a_usage
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
                id:
                  type: string
                  deprecated: false
                  description: |
                    A unique and immutable id for the usage. If not provided, it is autogenerated.
                  maxLength: 100
                  example: null
              required:
              - id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  usage:
                    $ref: "#/components/schemas/Usage"
                    description: |
                      Resource object representing usage
                required:
                - usage
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /usages:
    get:
      tags:
      - usages
      summary: List usages
      description: |
        **Advanced Usage-Based Billing**

        For high-scale usage ingestion, use [Advanced Usage-Based Billing](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/understanding-usages) with the [Usage Events API](/docs/api/usage_events). The Usage Events API supports schemaless event ingestion at scale, including [individual events](/docs/api/usage_events/create-a-usage-event), [batch ingestion](/docs/api/usage_events/ingest-usages-in-batch), and [usage file ingestion](/docs/api/usage_files/usage-file-object).

        Retrieves the list of usages. This endpoint is part of the [Usages API](/docs/api/usages) for **Automated Metered Billing**.
      operationId: list_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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: id
        in: query
        description: |
          optional, string filter

          A unique and immutable id for the usage. If not provided, it is autogenerated.
          **Supported operators :**
          is, is_not, starts_with

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

          The id of the [subscription](/docs/api/subscriptions)
          to which this usage record belongs.
          **Supported operators :**
          is, is_not, starts_with

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

          The time at which this usage occurred. Chargebee bills only those usages whose
          `usage_date`
          falls within a time when the subscription `status`
          was `active`
          or `non_renewing`.
          However, the remaining usage records are still stored and are
          [retrievable](/docs/api/usages/retrieve-a-usage).

          **Note:**
          If `usage_date`
          corresponds to a time already invoiced, then it is stored but never invoiced unless the [invoice is regenerated](/docs/api/subscriptions/regenerate-an-invoice)
          .
          **Supported operators :**
          after, before, on, between

          **Example →**
          *usage_date\[after\] = "1601220958"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1601220958"
          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: |
          Timestamp indicating when this usage resource was last updated.
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1601220958"
          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: item_price_id
        in: query
        description: |
          optional, string filter

          The id of the [item price](/docs/api/item_prices)
          to which this usage belongs. The item price must be a part of the subscription or should have been part of it historically.
          **Supported operators :**
          is, is_not, starts_with

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

          When the usage has been invoiced, this is the `id`
          of the [invoice](/docs/api/invoices).
          This is cleared when the invoice is `voided`
          or deleted.
          **Supported operators :**
          is, is_not, starts_with, is_present

          **Example →**
          *invoice_id\[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
            is_present:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
          example: null
      - name: source
        in: query
        description: |
          optional, enumerated string filter

          The source from which the usage record was created. Possible values are : admin_console, api, bulk_operation.

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

          **Example →**
          *source\[is\] = "api"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: api
          properties:
            is:
              type: string
              description: |-
                * `admin_console` - Operation made through the Chargebee admin UI
                * `api` - Operation made through the API
                * `bulk_operation` - Operation that are triggerd through bulk operation.
              enum:
              - admin_console
              - api
              - bulk_operation
              example: null
            is_not:
              type: string
              description: |-
                * `admin_console` - Operation made through the Chargebee admin UI
                * `api` - Operation made through the API
                * `bulk_operation` - Operation that are triggerd through bulk operation.
              enum:
              - admin_console
              - api
              - bulk_operation
              example: null
            in:
              type: string
              description: |-
                * `admin_console` - Operation made through the Chargebee admin UI
                * `api` - Operation made through the API
                * `bulk_operation` - Operation that are triggerd through bulk operation.
              enum:
              - admin_console
              - api
              - bulk_operation
              pattern: "^\\[(admin_console|api|bulk_operation)(,(admin_console|api|bulk_operation))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |-
                * `admin_console` - Operation made through the Chargebee admin UI
                * `api` - Operation made through the API
                * `bulk_operation` - Operation that are triggerd through bulk operation.
              enum:
              - admin_console
              - api
              - bulk_operation
              pattern: "^\\[(admin_console|api|bulk_operation)(,(admin_console|api|bulk_operation))*\\\
                ]$"
              example: null
      - name: sort_by
        in: query
        description: |
          optional, string filter

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

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

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

          This will sort the result based on the 'usage_date' attribute in ascending(earliest first) order.
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
          properties:
            asc:
              type: string
              enum:
              - usage_date
              - updated_at
              example: null
            desc:
              type: string
              enum:
              - usage_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:
                        usage:
                          $ref: "#/components/schemas/Usage"
                          description: Resource object representing usage
                      required:
                      - usage
                      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:
    get:
      tags:
      - events
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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\] = "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 : 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, add_usages_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, item_family_created, item_family_updated, item_family_deleted, item_created, item_updated, item_deleted, item_price_created, item_price_updated, item_price_deleted, attached_item_created, attached_item_updated, attached_item_deleted, differential_price_created, differential_price_updated, differential_price_deleted, feature_created, feature_updated, feature_deleted, feature_activated, feature_reactivated, feature_archived, item_entitlements_updated, entitlement_overrides_updated, entitlement_overrides_removed, item_entitlements_removed, entitlement_overrides_auto_removed, business_entity_created, business_entity_updated, business_entity_deleted, purchase_created.

          **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: "* `coupon_created` - Sent when a coupon is created. \n\
                * `coupon_updated` - Sent when a coupon is changed. \n* `coupon_deleted`\
                \ - Sent when a coupon is deleted. \n* `coupon_set_created` - Sent\
                \ when a coupon set is created\n* `coupon_set_updated` - Sent when\
                \ a coupon set is changed\n* `coupon_set_deleted` - Sent when a coupon\
                \ set is deleted\n* `coupon_codes_added` - Sent when coupon codes\
                \ are added in coupon set\n* `coupon_codes_deleted` - Sent when coupon\
                \ codes are deleted in coupon set\n* `coupon_codes_updated` - Sent\
                \ when coupon codes are updated\n* `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.\n* `customer_changed` - Sent when a customer\
                \ is changed\n* `customer_deleted` - Sent when a customer is deleted\n\
                * `customer_moved_out` - Sent when a customer is copied to another\
                \ site\n* `customer_moved_in` - Sent when a customer is copied from\
                \ another site\n* `promotional_credits_added` - Sent when a customer\
                \ prmotion credits added\n* `promotional_credits_deducted` - Sent\
                \ when a customer prmotion credits deducted\n* `subscription_created`\
                \ - Sent when a new subscription is created.\n* `subscription_created_with_backdating`\
                \ - Sent when a new subscription is created with backdating.\n* `subscription_started`\
                \ - Sent when a 'future' subscription gets started at the scheduled\
                \ date.\n* `subscription_trial_end_reminder` - Sent when the customer's\
                \ trial period is about to end.\n* `subscription_activated` - Sent\
                \ after the subscription has been moved from trial to active state\n\
                * `subscription_activated_with_backdating` - Sent after the subscription\
                \ changes to `active` from another `status`, while the change is backdated.\n\
                * `subscription_changed` - Sent after the subscription's recurring\
                \ items have been changed\n* `subscription_trial_extended` - Trial\
                \ Extension\n* `mrr_updated` - Sent when either of MRR or CMRR of\
                \ a subscription changes\n* `subscription_changed_with_backdating`\
                \ - Sent after the subscription's recurring items have been changed\
                \ with backdated date\n* `subscription_cancellation_scheduled` - Sent\
                \ when subscription is scheduled to cancel at end of current term\n\
                * `subscription_cancellation_reminder` - Sent when the customer's\
                \ subscription is nearing it's scheduled cancellation date.\n* `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'.\n* `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'.\n* `subscription_reactivated`\
                \ - Sent when the subscription is moved from cancelled state to active\
                \ or in_trial state\n* `subscription_reactivated_with_backdating`\
                \ - Sent when the subscription is moved from cancelled state to active\
                \ or in_trial state with past date\n* `subscription_renewed` - Sent\
                \ when the subscription is renewed from the current term.\n* `subscription_items_renewed`\
                \ - Sent when one or more Subscription Items are renewed\n* `subscription_scheduled_cancellation_removed`\
                \ - Sent when scheduled cancellation is removed for the subscription.\n\
                * `subscription_changes_scheduled` - Sent when subscription changes\
                \ are scheduled for later. Changes will be applied at the end of current\
                \ term.\n* `subscription_scheduled_changes_removed` - Sent when scheduled\
                \ change for the subscription is removed.\n* `subscription_shipping_address_updated`\
                \ - Triggered when shipping address is added or updated for a subscription.\n\
                * `subscription_deleted` - Sent when a subscription has been deleted\n\
                * `subscription_paused` - Sent when the subscription is paused.\n\
                * `subscription_pause_scheduled` - Sent when the subscription is scheduled\
                \ to pause.\n* `subscription_scheduled_pause_removed` - Triggered\
                \ when scheduled pause is removed for the subscription.\n* `subscription_resumed`\
                \ - Sent when the subscription is moved from paused state to active\
                \ state\n* `subscription_resumption_scheduled` - Triggered when the\
                \ subscription resumption is scheduled.\n* `subscription_scheduled_resumption_removed`\
                \ - Triggered when scheduled resumption is removed for the subscription.\n\
                * `subscription_advance_invoice_schedule_added` - Triggered when advance\
                \ invoice is scheduled for a subscription.\n* `subscription_advance_invoice_schedule_updated`\
                \ - Triggered when scheduled advance invoice is updated for a subscription.\n\
                * `subscription_advance_invoice_schedule_removed` - Triggered when\
                \ scheduled advance invoice is removed for a subscription.\n* `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.\n* `pending_invoice_updated`\
                \ - Event triggered when the option \"Notify and wait to close invoices\"\
                \ is enabled, and the 'Pending' invoice is updated.\n* `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.\n\
                * `invoice_generated_with_backdating` - Event triggered when a new\
                \ invoice is generated with past date as invoice date.\n* `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.\n* `invoice_deleted` - Event triggered\
                \ when an invoice is deleted.\n* `credit_note_created` - Sent when\
                \ a credit note is created\n* `credit_note_created_with_backdating`\
                \ - Sent when a credit note is created with past date as credit note\
                \ date\n* `credit_note_updated` - Sent when a credit note is updated\n\
                * `credit_note_deleted` - Sent when a credit note is deleted\n* `einvoice_created`\
                \ - Triggered when an e-invoice is created for an invoice or credit\
                \ note.\n* `einvoice_updated` - Triggered when an e-invoice is updated\
                \ (for example status or provider response changes).\n* `payment_schedules_created`\
                \ - Event triggered when new payment schedules are created for an\
                \ invoice\n* `payment_schedules_updated` - Event triggered when payment\
                \ schedules are updated for an invoice\n* `payment_schedule_scheme_created`\
                \ - Event triggered when a new payment schedule scheme is created\n\
                * `payment_schedule_scheme_deleted` - Event triggered when a payment\
                \ schedule scheme is deleted\n* `subscription_renewal_reminder` -\
                \ Sent before each subscription's renewal based on plan's period\n\
                * `add_usages_reminder` - Sent every month day before renewal date\
                \ of plan's period\n* `payment_due_reminder` - Sent after scheduled\
                \ days of payment failure\n* `transaction_created` - Triggered when\
                \ a transaction is recorded\n* `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.\n* `transaction_deleted` - Triggered\
                \ when a transaction is deleted. \n* `payment_succeeded` - Sent when\
                \ the payment is successfully collected\n* `payment_failed` - Sent\
                \ when attempt to charge customer's credit card fails\n* `dunning_updated`\
                \ - Sent when dunning is paused for an invoice\n* `payment_refunded`\
                \ - Sent when a payment refund is made\n* `payment_initiated` - Sent\
                \ when a payment is initiated via direct debit\n* `refund_initiated`\
                \ - Sent when a refund is initiated via direct debit\n* `netd_payment_due_reminder`\
                \ - **(Deprecated)** Sent when a invoice's due period is about to\
                \ end\n* `authorization_succeeded` - Triggered when a authorization\
                \ transaction is created.\n* `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.\n* `card_added` - Sent when a card\
                \ is added for a customer.\n* `card_updated` - Sent when the card\
                \ is updated for a customer.\n* `card_expiry_reminder` - Sent when\
                \ the customer's credit card is expiring soon. Sent 30 days before\
                \ the expiry date.\n* `card_expired` - Sent when a card for a customer\
                \ is expired\n* `card_deleted` - Sent when a card is deleted for a\
                \ customer\n* `payment_source_added` - Sent when a payment source\
                \ is added for a customer.\n* `payment_source_updated` - Sent when\
                \ the payment source is updated for a customer or when role is assigned\
                \ to the payment source.\n* `payment_source_deleted` - Sent when a\
                \ payment source is deleted for a customer\n* `payment_source_expiring`\
                \ - Sent when the customer's payment source is expiring soon. Sent\
                \ 30 days before the expiry date.\n* `payment_source_expired` - Sent\
                \ when a payment source for a customer is expired\n* `payment_source_locally_deleted`\
                \ - Sent when a payment source for a customer removed from Chargebee\n\
                * `virtual_bank_account_added` - Sent when a virtual bank account\
                \ is added for a customer.\n* `virtual_bank_account_updated` - Sent\
                \ when the virtual bank account is updated for a customer.\n* `virtual_bank_account_deleted`\
                \ - Sent when a virtual bank account is deleted for a customer.\n\
                * `token_created` - Sent when a Token is created\n* `token_consumed`\
                \ - Sent when a Token is consumed\n* `token_expired` - Sent when a\
                \ Token is expired\n* `unbilled_charges_created` - Triggered when\
                \ unbilled charges are created\n* `unbilled_charges_voided` - Triggered\
                \ when unbilled charges are voided\n* `unbilled_charges_deleted` -\
                \ Triggered when unbilled charges are deleted\n* `unbilled_charges_invoiced`\
                \ - Triggered when unbilled charges are invoiced\n* `order_created`\
                \ - Triggered when order is created\n* `order_updated` - Triggered\
                \ when order is updated\n* `order_cancelled` - Triggered when order\
                \ is cancelled\n* `order_delivered` - Triggered when order is marked\
                \ as delivered\n* `order_returned` - Triggered when order is marked\
                \ as returned\n* `order_ready_to_process` - Triggered when order reaches\
                \ it's order date\n* `order_ready_to_ship` - Triggered when order\
                \ reaches it's shipping date\n* `order_deleted` - Triggered when order\
                \ is deleted\n* `order_resent` - Triggered when order is resent\n\
                * `quote_created` - Triggered when quote is created\n* `quote_updated`\
                \ - Triggered when quote is updated\n* `quote_deleted` - Triggered\
                \ when quote is deleted\n* `tax_withheld_recorded` - Triggered when\
                \ a tax withheld is recorded for an invoice\n* `tax_withheld_deleted`\
                \ - Triggered when a tax withheld is deleted\n* `tax_withheld_refunded`\
                \ - Sent when a tax withheld refund is made\n* `gift_scheduled` -\
                \ Triggered when a new gift is created\n* `gift_unclaimed` - Triggered\
                \ when a new gift is unclaimed and is ready to be claimed\n* `gift_claimed`\
                \ - Triggered when a gift is claimed\n* `gift_expired` - Triggered\
                \ when a gift expires\n* `gift_cancelled` - Triggered when a gift\
                \ is cancelled.\n* `gift_updated` - Triggered when a gift is updated\n\
                * `hierarchy_created` - Triggered when a hierarchy is created\n* `hierarchy_deleted`\
                \ - Triggered when a hierarchy is deleted\n* `payment_intent_created`\
                \ - Sent when a Payment intent is created\n* `payment_intent_updated`\
                \ - Sent when a Payment intent is updated\n* `contract_term_created`\
                \ - Triggered when new contract term is created\n* `contract_term_renewed`\
                \ - Triggered when new contract term is renewed\n* `contract_term_terminated`\
                \ - Triggered when contract term is terminated\n* `contract_term_completed`\
                \ - Triggered when contract term is completed\n* `contract_term_cancelled`\
                \ - Triggered when contract term is cancelled\n* `item_family_created`\
                \ - Triggered when an item family is created\n* `item_family_updated`\
                \ - Triggered when an item family is updated\n* `item_family_deleted`\
                \ - Triggered when an item family is deleted\n* `item_created` - Triggered\
                \ when an item is created\n* `item_updated` - Triggered when an item\
                \ is updated\n* `item_deleted` - Triggered when an item is deleted\n\
                * `item_price_created` - Triggered when an item price is created\n\
                * `item_price_updated` - Triggered when an item price is updated\n\
                * `item_price_deleted` - Triggered when an item price is deleted\n\
                * `attached_item_created` - Triggered when an Attached item is created\n\
                * `attached_item_updated` - Triggered when an Attached item is updated\n\
                * `attached_item_deleted` - Triggered when an Attached item is deleted\n\
                * `differential_price_created` - Triggered when a differential price\
                \ is created\n* `differential_price_updated` - Triggered when a differential\
                \ price is updated\n* `differential_price_deleted` - Triggered when\
                \ a differential price is deleted\n* `feature_created` - Triggered\
                \ when a feature is created.\n* `feature_updated` - Triggered when\
                \ an feature is updated\n* `feature_deleted` - Triggered when a feature\
                \ is deleted\n* `feature_activated` - Triggered when a feature `status`\
                \ transitions to `active` for the first time.\n* `feature_reactivated`\
                \ - Triggered when a feature `status` transitions to `active` for\
                \ the second time or more.\n* `feature_archived` - Triggered when\
                \ an feature is archived\n* `item_entitlements_updated` - Triggered\
                \ when item entitlements are updated to a feature\n* `entitlement_overrides_updated`\
                \ - Triggered when an override entitlement is updated\n* `entitlement_overrides_removed`\
                \ - Triggered when an override entitlement is removed\n* `item_entitlements_removed`\
                \ - Triggered when item entitlements are removed for a feature\n*\
                \ `entitlement_overrides_auto_removed` - Triggered when Subscription\
                \ entitlements overrides for a feature are auto removed after expiry\n\
                * `subscription_entitlements_created` - Triggered when subscription\
                \ entitlements are created for a new subscription\n* `subscription_entitlements_updated`\
                \ - Triggered when subscription entitlements are updated due to the\
                \ subscription change event\n* `business_entity_created` - Sent when\
                \ a business entity is created. \n* `business_entity_updated` - Sent\
                \ when a business entity is updated. \n* `business_entity_deleted`\
                \ - Sent when a business entity is deleted. \n* `customer_business_entity_changed`\
                \ - Sent when a customer's business entity is changed.\n* `subscription_business_entity_changed`\
                \ - Sent when a subscription's business entity is changed. \n* `payment_source_business_entity_changed`\
                \ - Sent when a payment source's business entity is changed.\n* `purchase_created`\
                \ - Triggered when purchase action is completed successfully\n* `voucher_created`\
                \ - Triggered when a payment voucher is created\n* `voucher_expired`\
                \ - Triggered when a payment voucher is expired\n* `voucher_create_failed`\
                \ - Triggered when a payment voucher creation is failed\n* `product_created`\
                \ - **(Deprecated)** Triggered when the product create is completed\
                \ successfully\n* `product_updated` - **(Deprecated)** Triggered when\
                \ the product update is completed successfully\n* `product_deleted`\
                \ - **(Deprecated)** Triggered when the product delete is completed\
                \ successfully\n* `variant_created` - **(Deprecated)** Triggered when\
                \ product variant create completed successfully\n* `variant_updated`\
                \ - **(Deprecated)** Triggered when product variant update completed\
                \ successfully\n* `variant_deleted` - **(Deprecated)** Triggered when\
                \ product variant delete completed successfully\n* `item_price_entitlements_updated`\
                \ - Triggered when item Price entitlements are updated to a feature\n\
                * `item_price_entitlements_removed` - Triggered when item price entitlements\
                \ are removed for a feature\n* `subscription_ramp_created` - Triggered\
                \ when a subscription ramp is created.\n* `subscription_ramp_deleted`\
                \ - Triggered when a subscription ramp is deleted.\n* `subscription_ramp_applied`\
                \ - Triggered when a subscription ramp is applied.\n* `subscription_ramp_drafted`\
                \ - Triggered when a subscription ramp is moved to draft status.\n\
                * `subscription_ramp_updated` - Triggered when a subscription ramp\
                \ is updated.\n* `price_variant_created` - Triggered when a price\
                \ variant is created.\n* `price_variant_updated` - Triggered when\
                \ a price variant is updated.\n* `price_variant_deleted` - Triggered\
                \ when a price variant is deleted.\n* `customer_entitlements_updated`\
                \ - Triggered when entitlements for the list of customers got updated.\n\
                * `subscription_moved_in` - Triggered when a subscription moved from\
                \ other customer\n* `subscription_moved_out` - Triggered when a subscription\
                \ moved to other customer\n* `subscription_movement_failed` - Triggered\
                \ when a subscription movement failed\n* `omnichannel_subscription_created`\
                \ - Triggered when an omnichannel subscription is created\n* `omnichannel_subscription_item_renewed`\
                \ - Triggered when an omnichannel subscription item is renewed\n*\
                \ `omnichannel_subscription_item_downgrade_scheduled` - **(Deprecated)**\
                \ Triggered when an omnichannel subscription item is downgrade is\
                \ scheduled\n* `omnichannel_subscription_item_scheduled_downgrade_removed`\
                \ - **(Deprecated)** Triggered when an omnichannel subscription item\
                \ scheduled downgrade is removed\n* `omnichannel_subscription_item_downgraded`\
                \ - Triggered when an omnichannel subscription item is downgraded\n\
                * `omnichannel_subscription_item_expired` - Triggered when an omnichannel\
                \ subscription item is expired\n* `omnichannel_subscription_item_cancellation_scheduled`\
                \ - Triggered when an omnichannel subscription item is scheduled for\
                \ cancellation\n* `omnichannel_subscription_item_scheduled_cancellation_removed`\
                \ - Triggered when an omnichannel subscription item scheduled cancellation\
                \ is removed\n* `omnichannel_subscription_item_resubscribed` - Triggered\
                \ when an omnichannel subscription item is resubscribed\n* `omnichannel_subscription_item_upgraded`\
                \ - Triggered when an omnichannel subscription item is upgraded\n\
                * `omnichannel_subscription_item_cancelled` - Triggered when an omnichannel\
                \ subscription item is cancelled\n* `omnichannel_subscription_imported`\
                \ - Triggered when an omnichannel subscription item is imported\n\
                * `omnichannel_subscription_item_grace_period_started` - Triggered\
                \ when an omnichannel subscription item's grace period has started\n\
                * `omnichannel_subscription_item_grace_period_expired` - Triggered\
                \ when an omnichannel subscription item's grace period has expired\n\
                * `omnichannel_subscription_item_dunning_started` - Triggered when\
                \ an omnichannel subscription item's dunning has started\n* `omnichannel_subscription_item_dunning_expired`\
                \ - Triggered when an omnichannel subscription item's dunning has\
                \ expired\n* `rule_created` - Triggered when a rule is created\n*\
                \ `rule_updated` - Triggered when a rule is updated\n* `rule_deleted`\
                \ - Triggered when a rule is deleted\n* `record_purchase_failed` -\
                \ Triggered when an omnichannel record purchase is failed\n* `omnichannel_subscription_item_change_scheduled`\
                \ - Triggered when an omnichannel subscription item change is scheduled\n\
                * `omnichannel_subscription_item_scheduled_change_removed` - Triggered\
                \ when an omnichannel subscription item scheduled change is removed\n\
                * `omnichannel_subscription_item_reactivated` - Triggered when an\
                \ omnichannel subscription item's refund is reversed\n* `sales_order_created`\
                \ - Triggered when sales order is created\n* `sales_order_updated`\
                \ - Triggered when sales order is updated\n* `omnichannel_subscription_item_changed`\
                \ - Triggered when an omnichannel subscription item is changed\n*\
                \ `omnichannel_subscription_item_paused` - Triggered when an omnichannel\
                \ subscription item is paused\n* `omnichannel_subscription_item_resumed`\
                \ - Triggered when an omnichannel subscription item is resumed\n*\
                \ `omnichannel_one_time_order_created` - Triggered when an omnichannel\
                \ one time order is created\n* `omnichannel_one_time_order_item_cancelled`\
                \ - Triggered when an omnichannel one time order item is cancelled\n\
                * `usage_file_ingested` - Triggered when a usage file is ingested\n\
                * `omnichannel_subscription_item_pause_scheduled` - Triggered when\
                \ an omnichannel subscription item scheduled for pause\n* `omnichannel_subscription_moved_in`\
                \ - Triggered when an omnichannel subscription is moved into another\
                \ customer\n* `omnichannel_transaction_created` - Triggered when an\
                \ omnichannel transaction is created\n* `alert_status_changed` - Triggered\
                \ when the status for an alert changes\n* `omnichannel_subscription_item_updated`\
                \ - Triggered when an omnichannel subscription item is updated\n*\
                \ `omnichannel_subscription_item_recovered` - Triggered when an omnichannel\
                \ subscription item is recovered from grace period or dunning\n* `omnichannel_subscription_item_mrr_updated`\
                \ - Triggered when an omnichannel subscription item's MRR is updated\n\
                * `ledger_account_balance_updated` - Triggered when a ledger account\
                \ balance changes for a subscription unit.\n* `grant_blocks_created`\
                \ - Triggered when one or more grant blocks are created for a subscription\
                \ unit.\n* `grant_blocks_updated` - Triggered when one or more grant\
                \ blocks are updated for a subscription unit.\n* `ledger_updated`\
                \ - Triggered when a batch of ledger operations is persisted for a\
                \ subscription unit.\n* `business_rule_created` - Triggered when a\
                \ business rule is created\n* `business_rule_updated` - Triggered\
                \ when a business rule is updated\n* `business_rule_activated` - Triggered\
                \ when a business rule is activated\n* `business_rule_deactivated`\
                \ - Triggered when a business rule is deactivated\n* `business_rule_deleted`\
                \ - Triggered when a business rule is deleted\n* `business_rule_released`\
                \ - Triggered when a business rule is released\n* `vault_token_created`\
                \ - Triggered when a payment method is tokenized and stored in the\
                \ vault.\n* `vault_token_updated` - Triggered when a vaulted payment\
                \ method is updated.\n* `vault_token_deleted` - Triggered when a vaulted\
                \ payment method is deleted from the vault.\n* `business_rules_applied`\
                \ - Triggered when rules are applied to any entity.\n* `business_ruleset_created`\
                \ - Triggered when a business ruleset is created\n* `business_ruleset_updated`\
                \ - Triggered when a business ruleset is updated\n* `business_ruleset_activated`\
                \ - Triggered when a business ruleset is activated\n* `business_ruleset_deactivated`\
                \ - Triggered when a business ruleset is deactivated\n* `business_ruleset_deleted`\
                \ - Triggered when a business ruleset is deleted"
              enum:
              - 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
              - einvoice_created
              - einvoice_updated
              - payment_schedules_created
              - payment_schedules_updated
              - payment_schedule_scheme_created
              - payment_schedule_scheme_deleted
              - subscription_renewal_reminder
              - add_usages_reminder
              - payment_due_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
              - item_family_created
              - item_family_updated
              - item_family_deleted
              - item_created
              - item_updated
              - item_deleted
              - item_price_created
              - item_price_updated
              - item_price_deleted
              - attached_item_created
              - attached_item_updated
              - attached_item_deleted
              - differential_price_created
              - differential_price_updated
              - differential_price_deleted
              - feature_created
              - feature_updated
              - feature_deleted
              - feature_activated
              - feature_reactivated
              - feature_archived
              - item_entitlements_updated
              - entitlement_overrides_updated
              - entitlement_overrides_removed
              - item_entitlements_removed
              - entitlement_overrides_auto_removed
              - subscription_entitlements_created
              - subscription_entitlements_updated
              - business_entity_created
              - business_entity_updated
              - business_entity_deleted
              - customer_business_entity_changed
              - subscription_business_entity_changed
              - payment_source_business_entity_changed
              - purchase_created
              - voucher_created
              - voucher_expired
              - voucher_create_failed
              - item_price_entitlements_updated
              - item_price_entitlements_removed
              - subscription_ramp_created
              - subscription_ramp_deleted
              - subscription_ramp_applied
              - subscription_ramp_drafted
              - subscription_ramp_updated
              - price_variant_created
              - price_variant_updated
              - price_variant_deleted
              - customer_entitlements_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
              - omnichannel_subscription_moved_in
              - omnichannel_transaction_created
              - alert_status_changed
              - omnichannel_subscription_item_updated
              - omnichannel_subscription_item_recovered
              - omnichannel_subscription_item_mrr_updated
              - ledger_account_balance_updated
              - grant_blocks_created
              - grant_blocks_updated
              - ledger_updated
              - business_rule_created
              - business_rule_updated
              - business_rule_activated
              - business_rule_deactivated
              - business_rule_deleted
              - business_rule_released
              - vault_token_created
              - vault_token_updated
              - vault_token_deleted
              - business_rules_applied
              - business_ruleset_created
              - business_ruleset_updated
              - business_ruleset_activated
              - business_ruleset_deactivated
              - business_ruleset_deleted
              example: null
            is_not:
              type: string
              description: "* `coupon_created` - Sent when a coupon is created. \n\
                * `coupon_updated` - Sent when a coupon is changed. \n* `coupon_deleted`\
                \ - Sent when a coupon is deleted. \n* `coupon_set_created` - Sent\
                \ when a coupon set is created\n* `coupon_set_updated` - Sent when\
                \ a coupon set is changed\n* `coupon_set_deleted` - Sent when a coupon\
                \ set is deleted\n* `coupon_codes_added` - Sent when coupon codes\
                \ are added in coupon set\n* `coupon_codes_deleted` - Sent when coupon\
                \ codes are deleted in coupon set\n* `coupon_codes_updated` - Sent\
                \ when coupon codes are updated\n* `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.\n* `customer_changed` - Sent when a customer\
                \ is changed\n* `customer_deleted` - Sent when a customer is deleted\n\
                * `customer_moved_out` - Sent when a customer is copied to another\
                \ site\n* `customer_moved_in` - Sent when a customer is copied from\
                \ another site\n* `promotional_credits_added` - Sent when a customer\
                \ prmotion credits added\n* `promotional_credits_deducted` - Sent\
                \ when a customer prmotion credits deducted\n* `subscription_created`\
                \ - Sent when a new subscription is created.\n* `subscription_created_with_backdating`\
                \ - Sent when a new subscription is created with backdating.\n* `subscription_started`\
                \ - Sent when a 'future' subscription gets started at the scheduled\
                \ date.\n* `subscription_trial_end_reminder` - Sent when the customer's\
                \ trial period is about to end.\n* `subscription_activated` - Sent\
                \ after the subscription has been moved from trial to active state\n\
                * `subscription_activated_with_backdating` - Sent after the subscription\
                \ changes to `active` from another `status`, while the change is backdated.\n\
                * `subscription_changed` - Sent after the subscription's recurring\
                \ items have been changed\n* `subscription_trial_extended` - Trial\
                \ Extension\n* `mrr_updated` - Sent when either of MRR or CMRR of\
                \ a subscription changes\n* `subscription_changed_with_backdating`\
                \ - Sent after the subscription's recurring items have been changed\
                \ with backdated date\n* `subscription_cancellation_scheduled` - Sent\
                \ when subscription is scheduled to cancel at end of current term\n\
                * `subscription_cancellation_reminder` - Sent when the customer's\
                \ subscription is nearing it's scheduled cancellation date.\n* `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'.\n* `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'.\n* `subscription_reactivated`\
                \ - Sent when the subscription is moved from cancelled state to active\
                \ or in_trial state\n* `subscription_reactivated_with_backdating`\
                \ - Sent when the subscription is moved from cancelled state to active\
                \ or in_trial state with past date\n* `subscription_renewed` - Sent\
                \ when the subscription is renewed from the current term.\n* `subscription_items_renewed`\
                \ - Sent when one or more Subscription Items are renewed\n* `subscription_scheduled_cancellation_removed`\
                \ - Sent when scheduled cancellation is removed for the subscription.\n\
                * `subscription_changes_scheduled` - Sent when subscription changes\
                \ are scheduled for later. Changes will be applied at the end of current\
                \ term.\n* `subscription_scheduled_changes_removed` - Sent when scheduled\
                \ change for the subscription is removed.\n* `subscription_shipping_address_updated`\
                \ - Triggered when shipping address is added or updated for a subscription.\n\
                * `subscription_deleted` - Sent when a subscription has been deleted\n\
                * `subscription_paused` - Sent when the subscription is paused.\n\
                * `subscription_pause_scheduled` - Sent when the subscription is scheduled\
                \ to pause.\n* `subscription_scheduled_pause_removed` - Triggered\
                \ when scheduled pause is removed for the subscription.\n* `subscription_resumed`\
                \ - Sent when the subscription is moved from paused state to active\
                \ state\n* `subscription_resumption_scheduled` - Triggered when the\
                \ subscription resumption is scheduled.\n* `subscription_scheduled_resumption_removed`\
                \ - Triggered when scheduled resumption is removed for the subscription.\n\
                * `subscription_advance_invoice_schedule_added` - Triggered when advance\
                \ invoice is scheduled for a subscription.\n* `subscription_advance_invoice_schedule_updated`\
                \ - Triggered when scheduled advance invoice is updated for a subscription.\n\
                * `subscription_advance_invoice_schedule_removed` - Triggered when\
                \ scheduled advance invoice is removed for a subscription.\n* `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.\n* `pending_invoice_updated`\
                \ - Event triggered when the option \"Notify and wait to close invoices\"\
                \ is enabled, and the 'Pending' invoice is updated.\n* `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.\n\
                * `invoice_generated_with_backdating` - Event triggered when a new\
                \ invoice is generated with past date as invoice date.\n* `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.\n* `invoice_deleted` - Event triggered\
                \ when an invoice is deleted.\n* `credit_note_created` - Sent when\
                \ a credit note is created\n* `credit_note_created_with_backdating`\
                \ - Sent when a credit note is created with past date as credit note\
                \ date\n* `credit_note_updated` - Sent when a credit note is updated\n\
                * `credit_note_deleted` - Sent when a credit note is deleted\n* `einvoice_created`\
                \ - Triggered when an e-invoice is created for an invoice or credit\
                \ note.\n* `einvoice_updated` - Triggered when an e-invoice is updated\
                \ (for example status or provider response changes).\n* `payment_schedules_created`\
                \ - Event triggered when new payment schedules are created for an\
                \ invoice\n* `payment_schedules_updated` - Event triggered when payment\
                \ schedules are updated for an invoice\n* `payment_schedule_scheme_created`\
                \ - Event triggered when a new payment schedule scheme is created\n\
                * `payment_schedule_scheme_deleted` - Event triggered when a payment\
                \ schedule scheme is deleted\n* `subscription_renewal_reminder` -\
                \ Sent before each subscription's renewal based on plan's period\n\
                * `add_usages_reminder` - Sent every month day before renewal date\
                \ of plan's period\n* `payment_due_reminder` - Sent after scheduled\
                \ days of payment failure\n* `transaction_created` - Triggered when\
                \ a transaction is recorded\n* `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.\n* `transaction_deleted` - Triggered\
                \ when a transaction is deleted. \n* `payment_succeeded` - Sent when\
                \ the payment is successfully collected\n* `payment_failed` - Sent\
                \ when attempt to charge customer's credit card fails\n* `dunning_updated`\
                \ - Sent when dunning is paused for an invoice\n* `payment_refunded`\
                \ - Sent when a payment refund is made\n* `payment_initiated` - Sent\
                \ when a payment is initiated via direct debit\n* `refund_initiated`\
                \ - Sent when a refund is initiated via direct debit\n* `netd_payment_due_reminder`\
                \ - **(Deprecated)** Sent when a invoice's due period is about to\
                \ end\n* `authorization_succeeded` - Triggered when a authorization\
                \ transaction is created.\n* `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.\n* `card_added` - Sent when a card\
                \ is added for a customer.\n* `card_updated` - Sent when the card\
                \ is updated for a customer.\n* `card_expiry_reminder` - Sent when\
                \ the customer's credit card is expiring soon. Sent 30 days before\
                \ the expiry date.\n* `card_expired` - Sent when a card for a customer\
                \ is expired\n* `card_deleted` - Sent when a card is deleted for a\
                \ customer\n* `payment_source_added` - Sent when a payment source\
                \ is added for a customer.\n* `payment_source_updated` - Sent when\
                \ the payment source is updated for a customer or when role is assigned\
                \ to the payment source.\n* `payment_source_deleted` - Sent when a\
                \ payment source is deleted for a customer\n* `payment_source_expiring`\
                \ - Sent when the customer's payment source is expiring soon. Sent\
                \ 30 days before the expiry date.\n* `payment_source_expired` - Sent\
                \ when a payment source for a customer is expired\n* `payment_source_locally_deleted`\
                \ - Sent when a payment source for a customer removed from Chargebee\n\
                * `virtual_bank_account_added` - Sent when a virtual bank account\
                \ is added for a customer.\n* `virtual_bank_account_updated` - Sent\
                \ when the virtual bank account is updated for a customer.\n* `virtual_bank_account_deleted`\
                \ - Sent when a virtual bank account is deleted for a customer.\n\
                * `token_created` - Sent when a Token is created\n* `token_consumed`\
                \ - Sent when a Token is consumed\n* `token_expired` - Sent when a\
                \ Token is expired\n* `unbilled_charges_created` - Triggered when\
                \ unbilled charges are created\n* `unbilled_charges_voided` - Triggered\
                \ when unbilled charges are voided\n* `unbilled_charges_deleted` -\
                \ Triggered when unbilled charges are deleted\n* `unbilled_charges_invoiced`\
                \ - Triggered when unbilled charges are invoiced\n* `order_created`\
                \ - Triggered when order is created\n* `order_updated` - Triggered\
                \ when order is updated\n* `order_cancelled` - Triggered when order\
                \ is cancelled\n* `order_delivered` - Triggered when order is marked\
                \ as delivered\n* `order_returned` - Triggered when order is marked\
                \ as returned\n* `order_ready_to_process` - Triggered when order reaches\
                \ it's order date\n* `order_ready_to_ship` - Triggered when order\
                \ reaches it's shipping date\n* `order_deleted` - Triggered when order\
                \ is deleted\n* `order_resent` - Triggered when order is resent\n\
                * `quote_created` - Triggered when quote is created\n* `quote_updated`\
                \ - Triggered when quote is updated\n* `quote_deleted` - Triggered\
                \ when quote is deleted\n* `tax_withheld_recorded` - Triggered when\
                \ a tax withheld is recorded for an invoice\n* `tax_withheld_deleted`\
                \ - Triggered when a tax withheld is deleted\n* `tax_withheld_refunded`\
                \ - Sent when a tax withheld refund is made\n* `gift_scheduled` -\
                \ Triggered when a new gift is created\n* `gift_unclaimed` - Triggered\
                \ when a new gift is unclaimed and is ready to be claimed\n* `gift_claimed`\
                \ - Triggered when a gift is claimed\n* `gift_expired` - Triggered\
                \ when a gift expires\n* `gift_cancelled` - Triggered when a gift\
                \ is cancelled.\n* `gift_updated` - Triggered when a gift is updated\n\
                * `hierarchy_created` - Triggered when a hierarchy is created\n* `hierarchy_deleted`\
                \ - Triggered when a hierarchy is deleted\n* `payment_intent_created`\
                \ - Sent when a Payment intent is created\n* `payment_intent_updated`\
                \ - Sent when a Payment intent is updated\n* `contract_term_created`\
                \ - Triggered when new contract term is created\n* `contract_term_renewed`\
                \ - Triggered when new contract term is renewed\n* `contract_term_terminated`\
                \ - Triggered when contract term is terminated\n* `contract_term_completed`\
                \ - Triggered when contract term is completed\n* `contract_term_cancelled`\
                \ - Triggered when contract term is cancelled\n* `item_family_created`\
                \ - Triggered when an item family is created\n* `item_family_updated`\
                \ - Triggered when an item family is updated\n* `item_family_deleted`\
                \ - Triggered when an item family is deleted\n* `item_created` - Triggered\
                \ when an item is created\n* `item_updated` - Triggered when an item\
                \ is updated\n* `item_deleted` - Triggered when an item is deleted\n\
                * `item_price_created` - Triggered when an item price is created\n\
                * `item_price_updated` - Triggered when an item price is updated\n\
                * `item_price_deleted` - Triggered when an item price is deleted\n\
                * `attached_item_created` - Triggered when an Attached item is created\n\
                * `attached_item_updated` - Triggered when an Attached item is updated\n\
                * `attached_item_deleted` - Triggered when an Attached item is deleted\n\
                * `differential_price_created` - Triggered when a differential price\
                \ is created\n* `differential_price_updated` - Triggered when a differential\
                \ price is updated\n* `differential_price_deleted` - Triggered when\
                \ a differential price is deleted\n* `feature_created` - Triggered\
                \ when a feature is created.\n* `feature_updated` - Triggered when\
                \ an feature is updated\n* `feature_deleted` - Triggered when a feature\
                \ is deleted\n* `feature_activated` - Triggered when a feature `status`\
                \ transitions to `active` for the first time.\n* `feature_reactivated`\
                \ - Triggered when a feature `status` transitions to `active` for\
                \ the second time or more.\n* `feature_archived` - Triggered when\
                \ an feature is archived\n* `item_entitlements_updated` - Triggered\
                \ when item entitlements are updated to a feature\n* `entitlement_overrides_updated`\
                \ - Triggered when an override entitlement is updated\n* `entitlement_overrides_removed`\
                \ - Triggered when an override entitlement is removed\n* `item_entitlements_removed`\
                \ - Triggered when item entitlements are removed for a feature\n*\
                \ `entitlement_overrides_auto_removed` - Triggered when Subscription\
                \ entitlements overrides for a feature are auto removed after expiry\n\
                * `subscription_entitlements_created` - Triggered when subscription\
                \ entitlements are created for a new subscription\n* `subscription_entitlements_updated`\
                \ - Triggered when subscription entitlements are updated due to the\
                \ subscription change event\n* `business_entity_created` - Sent when\
                \ a business entity is created. \n* `business_entity_updated` - Sent\
                \ when a business entity is updated. \n* `business_entity_deleted`\
                \ - Sent when a business entity is deleted. \n* `customer_business_entity_changed`\
                \ - Sent when a customer's business entity is changed.\n* `subscription_business_entity_changed`\
                \ - Sent when a subscription's business entity is changed. \n* `payment_source_business_entity_changed`\
                \ - Sent when a payment source's business entity is changed.\n* `purchase_created`\
                \ - Triggered when purchase action is completed successfully\n* `voucher_created`\
                \ - Triggered when a payment voucher is created\n* `voucher_expired`\
                \ - Triggered when a payment voucher is expired\n* `voucher_create_failed`\
                \ - Triggered when a payment voucher creation is failed\n* `product_created`\
                \ - **(Deprecated)** Triggered when the product create is completed\
                \ successfully\n* `product_updated` - **(Deprecated)** Triggered when\
                \ the product update is completed successfully\n* `product_deleted`\
                \ - **(Deprecated)** Triggered when the product delete is completed\
                \ successfully\n* `variant_created` - **(Deprecated)** Triggered when\
                \ product variant create completed successfully\n* `variant_updated`\
                \ - **(Deprecated)** Triggered when product variant update completed\
                \ successfully\n* `variant_deleted` - **(Deprecated)** Triggered when\
                \ product variant delete completed successfully\n* `item_price_entitlements_updated`\
                \ - Triggered when item Price entitlements are updated to a feature\n\
                * `item_price_entitlements_removed` - Triggered when item price entitlements\
                \ are removed for a feature\n* `subscription_ramp_created` - Triggered\
                \ when a subscription ramp is created.\n* `subscription_ramp_deleted`\
                \ - Triggered when a subscription ramp is deleted.\n* `subscription_ramp_applied`\
                \ - Triggered when a subscription ramp is applied.\n* `subscription_ramp_drafted`\
                \ - Triggered when a subscription ramp is moved to draft status.\n\
                * `subscription_ramp_updated` - Triggered when a subscription ramp\
                \ is updated.\n* `price_variant_created` - Triggered when a price\
                \ variant is created.\n* `price_variant_updated` - Triggered when\
                \ a price variant is updated.\n* `price_variant_deleted` - Triggered\
                \ when a price variant is deleted.\n* `customer_entitlements_updated`\
                \ - Triggered when entitlements for the list of customers got updated.\n\
                * `subscription_moved_in` - Triggered when a subscription moved from\
                \ other customer\n* `subscription_moved_out` - Triggered when a subscription\
                \ moved to other customer\n* `subscription_movement_failed` - Triggered\
                \ when a subscription movement failed\n* `omnichannel_subscription_created`\
                \ - Triggered when an omnichannel subscription is created\n* `omnichannel_subscription_item_renewed`\
                \ - Triggered when an omnichannel subscription item is renewed\n*\
                \ `omnichannel_subscription_item_downgrade_scheduled` - **(Deprecated)**\
                \ Triggered when an omnichannel subscription item is downgrade is\
                \ scheduled\n* `omnichannel_subscription_item_scheduled_downgrade_removed`\
                \ - **(Deprecated)** Triggered when an omnichannel subscription item\
                \ scheduled downgrade is removed\n* `omnichannel_subscription_item_downgraded`\
                \ - Triggered when an omnichannel subscription item is downgraded\n\
                * `omnichannel_subscription_item_expired` - Triggered when an omnichannel\
                \ subscription item is expired\n* `omnichannel_subscription_item_cancellation_scheduled`\
                \ - Triggered when an omnichannel subscription item is scheduled for\
                \ cancellation\n* `omnichannel_subscription_item_scheduled_cancellation_removed`\
                \ - Triggered when an omnichannel subscription item scheduled cancellation\
                \ is removed\n* `omnichannel_subscription_item_resubscribed` - Triggered\
                \ when an omnichannel subscription item is resubscribed\n* `omnichannel_subscription_item_upgraded`\
                \ - Triggered when an omnichannel subscription item is upgraded\n\
                * `omnichannel_subscription_item_cancelled` - Triggered when an omnichannel\
                \ subscription item is cancelled\n* `omnichannel_subscription_imported`\
                \ - Triggered when an omnichannel subscription item is imported\n\
                * `omnichannel_subscription_item_grace_period_started` - Triggered\
                \ when an omnichannel subscription item's grace period has started\n\
                * `omnichannel_subscription_item_grace_period_expired` - Triggered\
                \ when an omnichannel subscription item's grace period has expired\n\
                * `omnichannel_subscription_item_dunning_started` - Triggered when\
                \ an omnichannel subscription item's dunning has started\n* `omnichannel_subscription_item_dunning_expired`\
                \ - Triggered when an omnichannel subscription item's dunning has\
                \ expired\n* `rule_created` - Triggered when a rule is created\n*\
                \ `rule_updated` - Triggered when a rule is updated\n* `rule_deleted`\
                \ - Triggered when a rule is deleted\n* `record_purchase_failed` -\
                \ Triggered when an omnichannel record purchase is failed\n* `omnichannel_subscription_item_change_scheduled`\
                \ - Triggered when an omnichannel subscription item change is scheduled\n\
                * `omnichannel_subscription_item_scheduled_change_removed` - Triggered\
                \ when an omnichannel subscription item scheduled change is removed\n\
                * `omnichannel_subscription_item_reactivated` - Triggered when an\
                \ omnichannel subscription item's refund is reversed\n* `sales_order_created`\
                \ - Triggered when sales order is created\n* `sales_order_updated`\
                \ - Triggered when sales order is updated\n* `omnichannel_subscription_item_changed`\
                \ - Triggered when an omnichannel subscription item is changed\n*\
                \ `omnichannel_subscription_item_paused` - Triggered when an omnichannel\
                \ subscription item is paused\n* `omnichannel_subscription_item_resumed`\
                \ - Triggered when an omnichannel subscription item is resumed\n*\
                \ `omnichannel_one_time_order_created` - Triggered when an omnichannel\
                \ one time order is created\n* `omnichannel_one_time_order_item_cancelled`\
                \ - Triggered when an omnichannel one time order item is cancelled\n\
                * `usage_file_ingested` - Triggered when a usage file is ingested\n\
                * `omnichannel_subscription_item_pause_scheduled` - Triggered when\
                \ an omnichannel subscription item scheduled for pause\n* `omnichannel_subscription_moved_in`\
                \ - Triggered when an omnichannel subscription is moved into another\
                \ customer\n* `omnichannel_transaction_created` - Triggered when an\
                \ omnichannel transaction is created\n* `alert_status_changed` - Triggered\
                \ when the status for an alert changes\n* `omnichannel_subscription_item_updated`\
                \ - Triggered when an omnichannel subscription item is updated\n*\
                \ `omnichannel_subscription_item_recovered` - Triggered when an omnichannel\
                \ subscription item is recovered from grace period or dunning\n* `omnichannel_subscription_item_mrr_updated`\
                \ - Triggered when an omnichannel subscription item's MRR is updated\n\
                * `ledger_account_balance_updated` - Triggered when a ledger account\
                \ balance changes for a subscription unit.\n* `grant_blocks_created`\
                \ - Triggered when one or more grant blocks are created for a subscription\
                \ unit.\n* `grant_blocks_updated` - Triggered when one or more grant\
                \ blocks are updated for a subscription unit.\n* `ledger_updated`\
                \ - Triggered when a batch of ledger operations is persisted for a\
                \ subscription unit.\n* `business_rule_created` - Triggered when a\
                \ business rule is created\n* `business_rule_updated` - Triggered\
                \ when a business rule is updated\n* `business_rule_activated` - Triggered\
                \ when a business rule is activated\n* `business_rule_deactivated`\
                \ - Triggered when a business rule is deactivated\n* `business_rule_deleted`\
                \ - Triggered when a business rule is deleted\n* `business_rule_released`\
                \ - Triggered when a business rule is released\n* `vault_token_created`\
                \ - Triggered when a payment method is tokenized and stored in the\
                \ vault.\n* `vault_token_updated` - Triggered when a vaulted payment\
                \ method is updated.\n* `vault_token_deleted` - Triggered when a vaulted\
                \ payment method is deleted from the vault.\n* `business_rules_applied`\
                \ - Triggered when rules are applied to any entity.\n* `business_ruleset_created`\
                \ - Triggered when a business ruleset is created\n* `business_ruleset_updated`\
                \ - Triggered when a business ruleset is updated\n* `business_ruleset_activated`\
                \ - Triggered when a business ruleset is activated\n* `business_ruleset_deactivated`\
                \ - Triggered when a business ruleset is deactivated\n* `business_ruleset_deleted`\
                \ - Triggered when a business ruleset is deleted"
              enum:
              - 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
              - einvoice_created
              - einvoice_updated
              - payment_schedules_created
              - payment_schedules_updated
              - payment_schedule_scheme_created
              - payment_schedule_scheme_deleted
              - subscription_renewal_reminder
              - add_usages_reminder
              - payment_due_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
              - item_family_created
              - item_family_updated
              - item_family_deleted
              - item_created
              - item_updated
              - item_deleted
              - item_price_created
              - item_price_updated
              - item_price_deleted
              - attached_item_created
              - attached_item_updated
              - attached_item_deleted
              - differential_price_created
              - differential_price_updated
              - differential_price_deleted
              - feature_created
              - feature_updated
              - feature_deleted
              - feature_activated
              - feature_reactivated
              - feature_archived
              - item_entitlements_updated
              - entitlement_overrides_updated
              - entitlement_overrides_removed
              - item_entitlements_removed
              - entitlement_overrides_auto_removed
              - subscription_entitlements_created
              - subscription_entitlements_updated
              - business_entity_created
              - business_entity_updated
              - business_entity_deleted
              - customer_business_entity_changed
              - subscription_business_entity_changed
              - payment_source_business_entity_changed
              - purchase_created
              - voucher_created
              - voucher_expired
              - voucher_create_failed
              - item_price_entitlements_updated
              - item_price_entitlements_removed
              - subscription_ramp_created
              - subscription_ramp_deleted
              - subscription_ramp_applied
              - subscription_ramp_drafted
              - subscription_ramp_updated
              - price_variant_created
              - price_variant_updated
              - price_variant_deleted
              - customer_entitlements_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
              - omnichannel_subscription_moved_in
              - omnichannel_transaction_created
              - alert_status_changed
              - omnichannel_subscription_item_updated
              - omnichannel_subscription_item_recovered
              - omnichannel_subscription_item_mrr_updated
              - ledger_account_balance_updated
              - grant_blocks_created
              - grant_blocks_updated
              - ledger_updated
              - business_rule_created
              - business_rule_updated
              - business_rule_activated
              - business_rule_deactivated
              - business_rule_deleted
              - business_rule_released
              - vault_token_created
              - vault_token_updated
              - vault_token_deleted
              - business_rules_applied
              - business_ruleset_created
              - business_ruleset_updated
              - business_ruleset_activated
              - business_ruleset_deactivated
              - business_ruleset_deleted
              example: null
            in:
              type: string
              description: "* `coupon_created` - Sent when a coupon is created. \n\
                * `coupon_updated` - Sent when a coupon is changed. \n* `coupon_deleted`\
                \ - Sent when a coupon is deleted. \n* `coupon_set_created` - Sent\
                \ when a coupon set is created\n* `coupon_set_updated` - Sent when\
                \ a coupon set is changed\n* `coupon_set_deleted` - Sent when a coupon\
                \ set is deleted\n* `coupon_codes_added` - Sent when coupon codes\
                \ are added in coupon set\n* `coupon_codes_deleted` - Sent when coupon\
                \ codes are deleted in coupon set\n* `coupon_codes_updated` - Sent\
                \ when coupon codes are updated\n* `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.\n* `customer_changed` - Sent when a customer\
                \ is changed\n* `customer_deleted` - Sent when a customer is deleted\n\
                * `customer_moved_out` - Sent when a customer is copied to another\
                \ site\n* `customer_moved_in` - Sent when a customer is copied from\
                \ another site\n* `promotional_credits_added` - Sent when a customer\
                \ prmotion credits added\n* `promotional_credits_deducted` - Sent\
                \ when a customer prmotion credits deducted\n* `subscription_created`\
                \ - Sent when a new subscription is created.\n* `subscription_created_with_backdating`\
                \ - Sent when a new subscription is created with backdating.\n* `subscription_started`\
                \ - Sent when a 'future' subscription gets started at the scheduled\
                \ date.\n* `subscription_trial_end_reminder` - Sent when the customer's\
                \ trial period is about to end.\n* `subscription_activated` - Sent\
                \ after the subscription has been moved from trial to active state\n\
                * `subscription_activated_with_backdating` - Sent after the subscription\
                \ changes to `active` from another `status`, while the change is backdated.\n\
                * `subscription_changed` - Sent after the subscription's recurring\
                \ items have been changed\n* `subscription_trial_extended` - Trial\
                \ Extension\n* `mrr_updated` - Sent when either of MRR or CMRR of\
                \ a subscription changes\n* `subscription_changed_with_backdating`\
                \ - Sent after the subscription's recurring items have been changed\
                \ with backdated date\n* `subscription_cancellation_scheduled` - Sent\
                \ when subscription is scheduled to cancel at end of current term\n\
                * `subscription_cancellation_reminder` - Sent when the customer's\
                \ subscription is nearing it's scheduled cancellation date.\n* `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'.\n* `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'.\n* `subscription_reactivated`\
                \ - Sent when the subscription is moved from cancelled state to active\
                \ or in_trial state\n* `subscription_reactivated_with_backdating`\
                \ - Sent when the subscription is moved from cancelled state to active\
                \ or in_trial state with past date\n* `subscription_renewed` - Sent\
                \ when the subscription is renewed from the current term.\n* `subscription_items_renewed`\
                \ - Sent when one or more Subscription Items are renewed\n* `subscription_scheduled_cancellation_removed`\
                \ - Sent when scheduled cancellation is removed for the subscription.\n\
                * `subscription_changes_scheduled` - Sent when subscription changes\
                \ are scheduled for later. Changes will be applied at the end of current\
                \ term.\n* `subscription_scheduled_changes_removed` - Sent when scheduled\
                \ change for the subscription is removed.\n* `subscription_shipping_address_updated`\
                \ - Triggered when shipping address is added or updated for a subscription.\n\
                * `subscription_deleted` - Sent when a subscription has been deleted\n\
                * `subscription_paused` - Sent when the subscription is paused.\n\
                * `subscription_pause_scheduled` - Sent when the subscription is scheduled\
                \ to pause.\n* `subscription_scheduled_pause_removed` - Triggered\
                \ when scheduled pause is removed for the subscription.\n* `subscription_resumed`\
                \ - Sent when the subscription is moved from paused state to active\
                \ state\n* `subscription_resumption_scheduled` - Triggered when the\
                \ subscription resumption is scheduled.\n* `subscription_scheduled_resumption_removed`\
                \ - Triggered when scheduled resumption is removed for the subscription.\n\
                * `subscription_advance_invoice_schedule_added` - Triggered when advance\
                \ invoice is scheduled for a subscription.\n* `subscription_advance_invoice_schedule_updated`\
                \ - Triggered when scheduled advance invoice is updated for a subscription.\n\
                * `subscription_advance_invoice_schedule_removed` - Triggered when\
                \ scheduled advance invoice is removed for a subscription.\n* `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.\n* `pending_invoice_updated`\
                \ - Event triggered when the option \"Notify and wait to close invoices\"\
                \ is enabled, and the 'Pending' invoice is updated.\n* `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.\n\
                * `invoice_generated_with_backdating` - Event triggered when a new\
                \ invoice is generated with past date as invoice date.\n* `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.\n* `invoice_deleted` - Event triggered\
                \ when an invoice is deleted.\n* `credit_note_created` - Sent when\
                \ a credit note is created\n* `credit_note_created_with_backdating`\
                \ - Sent when a credit note is created with past date as credit note\
                \ date\n* `credit_note_updated` - Sent when a credit note is updated\n\
                * `credit_note_deleted` - Sent when a credit note is deleted\n* `einvoice_created`\
                \ - Triggered when an e-invoice is created for an invoice or credit\
                \ note.\n* `einvoice_updated` - Triggered when an e-invoice is updated\
                \ (for example status or provider response changes).\n* `payment_schedules_created`\
                \ - Event triggered when new payment schedules are created for an\
                \ invoice\n* `payment_schedules_updated` - Event triggered when payment\
                \ schedules are updated for an invoice\n* `payment_schedule_scheme_created`\
                \ - Event triggered when a new payment schedule scheme is created\n\
                * `payment_schedule_scheme_deleted` - Event triggered when a payment\
                \ schedule scheme is deleted\n* `subscription_renewal_reminder` -\
                \ Sent before each subscription's renewal based on plan's period\n\
                * `add_usages_reminder` - Sent every month day before renewal date\
                \ of plan's period\n* `payment_due_reminder` - Sent after scheduled\
                \ days of payment failure\n* `transaction_created` - Triggered when\
                \ a transaction is recorded\n* `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.\n* `transaction_deleted` - Triggered\
                \ when a transaction is deleted. \n* `payment_succeeded` - Sent when\
                \ the payment is successfully collected\n* `payment_failed` - Sent\
                \ when attempt to charge customer's credit card fails\n* `dunning_updated`\
                \ - Sent when dunning is paused for an invoice\n* `payment_refunded`\
                \ - Sent when a payment refund is made\n* `payment_initiated` - Sent\
                \ when a payment is initiated via direct debit\n* `refund_initiated`\
                \ - Sent when a refund is initiated via direct debit\n* `netd_payment_due_reminder`\
                \ - **(Deprecated)** Sent when a invoice's due period is about to\
                \ end\n* `authorization_succeeded` - Triggered when a authorization\
                \ transaction is created.\n* `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.\n* `card_added` - Sent when a card\
                \ is added for a customer.\n* `card_updated` - Sent when the card\
                \ is updated for a customer.\n* `card_expiry_reminder` - Sent when\
                \ the customer's credit card is expiring soon. Sent 30 days before\
                \ the expiry date.\n* `card_expired` - Sent when a card for a customer\
                \ is expired\n* `card_deleted` - Sent when a card is deleted for a\
                \ customer\n* `payment_source_added` - Sent when a payment source\
                \ is added for a customer.\n* `payment_source_updated` - Sent when\
                \ the payment source is updated for a customer or when role is assigned\
                \ to the payment source.\n* `payment_source_deleted` - Sent when a\
                \ payment source is deleted for a customer\n* `payment_source_expiring`\
                \ - Sent when the customer's payment source is expiring soon. Sent\
                \ 30 days before the expiry date.\n* `payment_source_expired` - Sent\
                \ when a payment source for a customer is expired\n* `payment_source_locally_deleted`\
                \ - Sent when a payment source for a customer removed from Chargebee\n\
                * `virtual_bank_account_added` - Sent when a virtual bank account\
                \ is added for a customer.\n* `virtual_bank_account_updated` - Sent\
                \ when the virtual bank account is updated for a customer.\n* `virtual_bank_account_deleted`\
                \ - Sent when a virtual bank account is deleted for a customer.\n\
                * `token_created` - Sent when a Token is created\n* `token_consumed`\
                \ - Sent when a Token is consumed\n* `token_expired` - Sent when a\
                \ Token is expired\n* `unbilled_charges_created` - Triggered when\
                \ unbilled charges are created\n* `unbilled_charges_voided` - Triggered\
                \ when unbilled charges are voided\n* `unbilled_charges_deleted` -\
                \ Triggered when unbilled charges are deleted\n* `unbilled_charges_invoiced`\
                \ - Triggered when unbilled charges are invoiced\n* `order_created`\
                \ - Triggered when order is created\n* `order_updated` - Triggered\
                \ when order is updated\n* `order_cancelled` - Triggered when order\
                \ is cancelled\n* `order_delivered` - Triggered when order is marked\
                \ as delivered\n* `order_returned` - Triggered when order is marked\
                \ as returned\n* `order_ready_to_process` - Triggered when order reaches\
                \ it's order date\n* `order_ready_to_ship` - Triggered when order\
                \ reaches it's shipping date\n* `order_deleted` - Triggered when order\
                \ is deleted\n* `order_resent` - Triggered when order is resent\n\
                * `quote_created` - Triggered when quote is created\n* `quote_updated`\
                \ - Triggered when quote is updated\n* `quote_deleted` - Triggered\
                \ when quote is deleted\n* `tax_withheld_recorded` - Triggered when\
                \ a tax withheld is recorded for an invoice\n* `tax_withheld_deleted`\
                \ - Triggered when a tax withheld is deleted\n* `tax_withheld_refunded`\
                \ - Sent when a tax withheld refund is made\n* `gift_scheduled` -\
                \ Triggered when a new gift is created\n* `gift_unclaimed` - Triggered\
                \ when a new gift is unclaimed and is ready to be claimed\n* `gift_claimed`\
                \ - Triggered when a gift is claimed\n* `gift_expired` - Triggered\
                \ when a gift expires\n* `gift_cancelled` - Triggered when a gift\
                \ is cancelled.\n* `gift_updated` - Triggered when a gift is updated\n\
                * `hierarchy_created` - Triggered when a hierarchy is created\n* `hierarchy_deleted`\
                \ - Triggered when a hierarchy is deleted\n* `payment_intent_created`\
                \ - Sent when a Payment intent is created\n* `payment_intent_updated`\
                \ - Sent when a Payment intent is updated\n* `contract_term_created`\
                \ - Triggered when new contract term is created\n* `contract_term_renewed`\
                \ - Triggered when new contract term is renewed\n* `contract_term_terminated`\
                \ - Triggered when contract term is terminated\n* `contract_term_completed`\
                \ - Triggered when contract term is completed\n* `contract_term_cancelled`\
                \ - Triggered when contract term is cancelled\n* `item_family_created`\
                \ - Triggered when an item family is created\n* `item_family_updated`\
                \ - Triggered when an item family is updated\n* `item_family_deleted`\
                \ - Triggered when an item family is deleted\n* `item_created` - Triggered\
                \ when an item is created\n* `item_updated` - Triggered when an item\
                \ is updated\n* `item_deleted` - Triggered when an item is deleted\n\
                * `item_price_created` - Triggered when an item price is created\n\
                * `item_price_updated` - Triggered when an item price is updated\n\
                * `item_price_deleted` - Triggered when an item price is deleted\n\
                * `attached_item_created` - Triggered when an Attached item is created\n\
                * `attached_item_updated` - Triggered when an Attached item is updated\n\
                * `attached_item_deleted` - Triggered when an Attached item is deleted\n\
                * `differential_price_created` - Triggered when a differential price\
                \ is created\n* `differential_price_updated` - Triggered when a differential\
                \ price is updated\n* `differential_price_deleted` - Triggered when\
                \ a differential price is deleted\n* `feature_created` - Triggered\
                \ when a feature is created.\n* `feature_updated` - Triggered when\
                \ an feature is updated\n* `feature_deleted` - Triggered when a feature\
                \ is deleted\n* `feature_activated` - Triggered when a feature `status`\
                \ transitions to `active` for the first time.\n* `feature_reactivated`\
                \ - Triggered when a feature `status` transitions to `active` for\
                \ the second time or more.\n* `feature_archived` - Triggered when\
                \ an feature is archived\n* `item_entitlements_updated` - Triggered\
                \ when item entitlements are updated to a feature\n* `entitlement_overrides_updated`\
                \ - Triggered when an override entitlement is updated\n* `entitlement_overrides_removed`\
                \ - Triggered when an override entitlement is removed\n* `item_entitlements_removed`\
                \ - Triggered when item entitlements are removed for a feature\n*\
                \ `entitlement_overrides_auto_removed` - Triggered when Subscription\
                \ entitlements overrides for a feature are auto removed after expiry\n\
                * `subscription_entitlements_created` - Triggered when subscription\
                \ entitlements are created for a new subscription\n* `subscription_entitlements_updated`\
                \ - Triggered when subscription entitlements are updated due to the\
                \ subscription change event\n* `business_entity_created` - Sent when\
                \ a business entity is created. \n* `business_entity_updated` - Sent\
                \ when a business entity is updated. \n* `business_entity_deleted`\
                \ - Sent when a business entity is deleted. \n* `customer_business_entity_changed`\
                \ - Sent when a customer's business entity is changed.\n* `subscription_business_entity_changed`\
                \ - Sent when a subscription's business entity is changed. \n* `payment_source_business_entity_changed`\
                \ - Sent when a payment source's business entity is changed.\n* `purchase_created`\
                \ - Triggered when purchase action is completed successfully\n* `voucher_created`\
                \ - Triggered when a payment voucher is created\n* `voucher_expired`\
                \ - Triggered when a payment voucher is expired\n* `voucher_create_failed`\
                \ - Triggered when a payment voucher creation is failed\n* `product_created`\
                \ - **(Deprecated)** Triggered when the product create is completed\
                \ successfully\n* `product_updated` - **(Deprecated)** Triggered when\
                \ the product update is completed successfully\n* `product_deleted`\
                \ - **(Deprecated)** Triggered when the product delete is completed\
                \ successfully\n* `variant_created` - **(Deprecated)** Triggered when\
                \ product variant create completed successfully\n* `variant_updated`\
                \ - **(Deprecated)** Triggered when product variant update completed\
                \ successfully\n* `variant_deleted` - **(Deprecated)** Triggered when\
                \ product variant delete completed successfully\n* `item_price_entitlements_updated`\
                \ - Triggered when item Price entitlements are updated to a feature\n\
                * `item_price_entitlements_removed` - Triggered when item price entitlements\
                \ are removed for a feature\n* `subscription_ramp_created` - Triggered\
                \ when a subscription ramp is created.\n* `subscription_ramp_deleted`\
                \ - Triggered when a subscription ramp is deleted.\n* `subscription_ramp_applied`\
                \ - Triggered when a subscription ramp is applied.\n* `subscription_ramp_drafted`\
                \ - Triggered when a subscription ramp is moved to draft status.\n\
                * `subscription_ramp_updated` - Triggered when a subscription ramp\
                \ is updated.\n* `price_variant_created` - Triggered when a price\
                \ variant is created.\n* `price_variant_updated` - Triggered when\
                \ a price variant is updated.\n* `price_variant_deleted` - Triggered\
                \ when a price variant is deleted.\n* `customer_entitlements_updated`\
                \ - Triggered when entitlements for the list of customers got updated.\n\
                * `subscription_moved_in` - Triggered when a subscription moved from\
                \ other customer\n* `subscription_moved_out` - Triggered when a subscription\
                \ moved to other customer\n* `subscription_movement_failed` - Triggered\
                \ when a subscription movement failed\n* `omnichannel_subscription_created`\
                \ - Triggered when an omnichannel subscription is created\n* `omnichannel_subscription_item_renewed`\
                \ - Triggered when an omnichannel subscription item is renewed\n*\
                \ `omnichannel_subscription_item_downgrade_scheduled` - **(Deprecated)**\
                \ Triggered when an omnichannel subscription item is downgrade is\
                \ scheduled\n* `omnichannel_subscription_item_scheduled_downgrade_removed`\
                \ - **(Deprecated)** Triggered when an omnichannel subscription item\
                \ scheduled downgrade is removed\n* `omnichannel_subscription_item_downgraded`\
                \ - Triggered when an omnichannel subscription item is downgraded\n\
                * `omnichannel_subscription_item_expired` - Triggered when an omnichannel\
                \ subscription item is expired\n* `omnichannel_subscription_item_cancellation_scheduled`\
                \ - Triggered when an omnichannel subscription item is scheduled for\
                \ cancellation\n* `omnichannel_subscription_item_scheduled_cancellation_removed`\
                \ - Triggered when an omnichannel subscription item scheduled cancellation\
                \ is removed\n* `omnichannel_subscription_item_resubscribed` - Triggered\
                \ when an omnichannel subscription item is resubscribed\n* `omnichannel_subscription_item_upgraded`\
                \ - Triggered when an omnichannel subscription item is upgraded\n\
                * `omnichannel_subscription_item_cancelled` - Triggered when an omnichannel\
                \ subscription item is cancelled\n* `omnichannel_subscription_imported`\
                \ - Triggered when an omnichannel subscription item is imported\n\
                * `omnichannel_subscription_item_grace_period_started` - Triggered\
                \ when an omnichannel subscription item's grace period has started\n\
                * `omnichannel_subscription_item_grace_period_expired` - Triggered\
                \ when an omnichannel subscription item's grace period has expired\n\
                * `omnichannel_subscription_item_dunning_started` - Triggered when\
                \ an omnichannel subscription item's dunning has started\n* `omnichannel_subscription_item_dunning_expired`\
                \ - Triggered when an omnichannel subscription item's dunning has\
                \ expired\n* `rule_created` - Triggered when a rule is created\n*\
                \ `rule_updated` - Triggered when a rule is updated\n* `rule_deleted`\
                \ - Triggered when a rule is deleted\n* `record_purchase_failed` -\
                \ Triggered when an omnichannel record purchase is failed\n* `omnichannel_subscription_item_change_scheduled`\
                \ - Triggered when an omnichannel subscription item change is scheduled\n\
                * `omnichannel_subscription_item_scheduled_change_removed` - Triggered\
                \ when an omnichannel subscription item scheduled change is removed\n\
                * `omnichannel_subscription_item_reactivated` - Triggered when an\
                \ omnichannel subscription item's refund is reversed\n* `sales_order_created`\
                \ - Triggered when sales order is created\n* `sales_order_updated`\
                \ - Triggered when sales order is updated\n* `omnichannel_subscription_item_changed`\
                \ - Triggered when an omnichannel subscription item is changed\n*\
                \ `omnichannel_subscription_item_paused` - Triggered when an omnichannel\
                \ subscription item is paused\n* `omnichannel_subscription_item_resumed`\
                \ - Triggered when an omnichannel subscription item is resumed\n*\
                \ `omnichannel_one_time_order_created` - Triggered when an omnichannel\
                \ one time order is created\n* `omnichannel_one_time_order_item_cancelled`\
                \ - Triggered when an omnichannel one time order item is cancelled\n\
                * `usage_file_ingested` - Triggered when a usage file is ingested\n\
                * `omnichannel_subscription_item_pause_scheduled` - Triggered when\
                \ an omnichannel subscription item scheduled for pause\n* `omnichannel_subscription_moved_in`\
                \ - Triggered when an omnichannel subscription is moved into another\
                \ customer\n* `omnichannel_transaction_created` - Triggered when an\
                \ omnichannel transaction is created\n* `alert_status_changed` - Triggered\
                \ when the status for an alert changes\n* `omnichannel_subscription_item_updated`\
                \ - Triggered when an omnichannel subscription item is updated\n*\
                \ `omnichannel_subscription_item_recovered` - Triggered when an omnichannel\
                \ subscription item is recovered from grace period or dunning\n* `omnichannel_subscription_item_mrr_updated`\
                \ - Triggered when an omnichannel subscription item's MRR is updated\n\
                * `ledger_account_balance_updated` - Triggered when a ledger account\
                \ balance changes for a subscription unit.\n* `grant_blocks_created`\
                \ - Triggered when one or more grant blocks are created for a subscription\
                \ unit.\n* `grant_blocks_updated` - Triggered when one or more grant\
                \ blocks are updated for a subscription unit.\n* `ledger_updated`\
                \ - Triggered when a batch of ledger operations is persisted for a\
                \ subscription unit.\n* `business_rule_created` - Triggered when a\
                \ business rule is created\n* `business_rule_updated` - Triggered\
                \ when a business rule is updated\n* `business_rule_activated` - Triggered\
                \ when a business rule is activated\n* `business_rule_deactivated`\
                \ - Triggered when a business rule is deactivated\n* `business_rule_deleted`\
                \ - Triggered when a business rule is deleted\n* `business_rule_released`\
                \ - Triggered when a business rule is released\n* `vault_token_created`\
                \ - Triggered when a payment method is tokenized and stored in the\
                \ vault.\n* `vault_token_updated` - Triggered when a vaulted payment\
                \ method is updated.\n* `vault_token_deleted` - Triggered when a vaulted\
                \ payment method is deleted from the vault.\n* `business_rules_applied`\
                \ - Triggered when rules are applied to any entity.\n* `business_ruleset_created`\
                \ - Triggered when a business ruleset is created\n* `business_ruleset_updated`\
                \ - Triggered when a business ruleset is updated\n* `business_ruleset_activated`\
                \ - Triggered when a business ruleset is activated\n* `business_ruleset_deactivated`\
                \ - Triggered when a business ruleset is deactivated\n* `business_ruleset_deleted`\
                \ - Triggered when a business ruleset is deleted"
              enum:
              - 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
              - einvoice_created
              - einvoice_updated
              - payment_schedules_created
              - payment_schedules_updated
              - payment_schedule_scheme_created
              - payment_schedule_scheme_deleted
              - subscription_renewal_reminder
              - add_usages_reminder
              - payment_due_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
              - item_family_created
              - item_family_updated
              - item_family_deleted
              - item_created
              - item_updated
              - item_deleted
              - item_price_created
              - item_price_updated
              - item_price_deleted
              - attached_item_created
              - attached_item_updated
              - attached_item_deleted
              - differential_price_created
              - differential_price_updated
              - differential_price_deleted
              - feature_created
              - feature_updated
              - feature_deleted
              - feature_activated
              - feature_reactivated
              - feature_archived
              - item_entitlements_updated
              - entitlement_overrides_updated
              - entitlement_overrides_removed
              - item_entitlements_removed
              - entitlement_overrides_auto_removed
              - subscription_entitlements_created
              - subscription_entitlements_updated
              - business_entity_created
              - business_entity_updated
              - business_entity_deleted
              - customer_business_entity_changed
              - subscription_business_entity_changed
              - payment_source_business_entity_changed
              - purchase_created
              - voucher_created
              - voucher_expired
              - voucher_create_failed
              - item_price_entitlements_updated
              - item_price_entitlements_removed
              - subscription_ramp_created
              - subscription_ramp_deleted
              - subscription_ramp_applied
              - subscription_ramp_drafted
              - subscription_ramp_updated
              - price_variant_created
              - price_variant_updated
              - price_variant_deleted
              - customer_entitlements_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
              - omnichannel_subscription_moved_in
              - omnichannel_transaction_created
              - alert_status_changed
              - omnichannel_subscription_item_updated
              - omnichannel_subscription_item_recovered
              - omnichannel_subscription_item_mrr_updated
              - ledger_account_balance_updated
              - grant_blocks_created
              - grant_blocks_updated
              - ledger_updated
              - business_rule_created
              - business_rule_updated
              - business_rule_activated
              - business_rule_deactivated
              - business_rule_deleted
              - business_rule_released
              - vault_token_created
              - vault_token_updated
              - vault_token_deleted
              - business_rules_applied
              - business_ruleset_created
              - business_ruleset_updated
              - business_ruleset_activated
              - business_ruleset_deactivated
              - business_ruleset_deleted
              pattern: "^\\[(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|einvoice_created|einvoice_updated|payment_schedules_created|payment_schedules_updated|payment_schedule_scheme_created|payment_schedule_scheme_deleted|subscription_renewal_reminder|add_usages_reminder|payment_due_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|item_family_created|item_family_updated|item_family_deleted|item_created|item_updated|item_deleted|item_price_created|item_price_updated|item_price_deleted|attached_item_created|attached_item_updated|attached_item_deleted|differential_price_created|differential_price_updated|differential_price_deleted|feature_created|feature_updated|feature_deleted|feature_activated|feature_reactivated|feature_archived|item_entitlements_updated|entitlement_overrides_updated|entitlement_overrides_removed|item_entitlements_removed|entitlement_overrides_auto_removed|subscription_entitlements_created|subscription_entitlements_updated|business_entity_created|business_entity_updated|business_entity_deleted|customer_business_entity_changed|subscription_business_entity_changed|payment_source_business_entity_changed|purchase_created|voucher_created|voucher_expired|voucher_create_failed|product_created|product_updated|product_deleted|variant_created|variant_updated|variant_deleted|item_price_entitlements_updated|item_price_entitlements_removed|subscription_ramp_created|subscription_ramp_deleted|subscription_ramp_applied|subscription_ramp_drafted|subscription_ramp_updated|price_variant_created|price_variant_updated|price_variant_deleted|customer_entitlements_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|omnichannel_subscription_moved_in|omnichannel_transaction_created|alert_status_changed|omnichannel_subscription_item_updated|omnichannel_subscription_item_recovered|omnichannel_subscription_item_mrr_updated|ledger_account_balance_updated|grant_blocks_created|grant_blocks_updated|ledger_updated|business_rule_created|business_rule_updated|business_rule_activated|business_rule_deactivated|business_rule_deleted|business_rule_released|vault_token_created|vault_token_updated|vault_token_deleted|business_rules_applied|business_ruleset_created|business_ruleset_updated|business_ruleset_activated|business_ruleset_deactivated|business_ruleset_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|einvoice_created|einvoice_updated|payment_schedules_created|payment_schedules_updated|payment_schedule_scheme_created|payment_schedule_scheme_deleted|subscription_renewal_reminder|add_usages_reminder|payment_due_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|item_family_created|item_family_updated|item_family_deleted|item_created|item_updated|item_deleted|item_price_created|item_price_updated|item_price_deleted|attached_item_created|attached_item_updated|attached_item_deleted|differential_price_created|differential_price_updated|differential_price_deleted|feature_created|feature_updated|feature_deleted|feature_activated|feature_reactivated|feature_archived|item_entitlements_updated|entitlement_overrides_updated|entitlement_overrides_removed|item_entitlements_removed|entitlement_overrides_auto_removed|subscription_entitlements_created|subscription_entitlements_updated|business_entity_created|business_entity_updated|business_entity_deleted|customer_business_entity_changed|subscription_business_entity_changed|payment_source_business_entity_changed|purchase_created|voucher_created|voucher_expired|voucher_create_failed|product_created|product_updated|product_deleted|variant_created|variant_updated|variant_deleted|item_price_entitlements_updated|item_price_entitlements_removed|subscription_ramp_created|subscription_ramp_deleted|subscription_ramp_applied|subscription_ramp_drafted|subscription_ramp_updated|price_variant_created|price_variant_updated|price_variant_deleted|customer_entitlements_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|omnichannel_subscription_moved_in|omnichannel_transaction_created|alert_status_changed|omnichannel_subscription_item_updated|omnichannel_subscription_item_recovered|omnichannel_subscription_item_mrr_updated|ledger_account_balance_updated|grant_blocks_created|grant_blocks_updated|ledger_updated|business_rule_created|business_rule_updated|business_rule_activated|business_rule_deactivated|business_rule_deleted|business_rule_released|vault_token_created|vault_token_updated|vault_token_deleted|business_rules_applied|business_ruleset_created|business_ruleset_updated|business_ruleset_activated|business_ruleset_deactivated|business_ruleset_deleted))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: "* `coupon_created` - Sent when a coupon is created. \n\
                * `coupon_updated` - Sent when a coupon is changed. \n* `coupon_deleted`\
                \ - Sent when a coupon is deleted. \n* `coupon_set_created` - Sent\
                \ when a coupon set is created\n* `coupon_set_updated` - Sent when\
                \ a coupon set is changed\n* `coupon_set_deleted` - Sent when a coupon\
                \ set is deleted\n* `coupon_codes_added` - Sent when coupon codes\
                \ are added in coupon set\n* `coupon_codes_deleted` - Sent when coupon\
                \ codes are deleted in coupon set\n* `coupon_codes_updated` - Sent\
                \ when coupon codes are updated\n* `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.\n* `customer_changed` - Sent when a customer\
                \ is changed\n* `customer_deleted` - Sent when a customer is deleted\n\
                * `customer_moved_out` - Sent when a customer is copied to another\
                \ site\n* `customer_moved_in` - Sent when a customer is copied from\
                \ another site\n* `promotional_credits_added` - Sent when a customer\
                \ prmotion credits added\n* `promotional_credits_deducted` - Sent\
                \ when a customer prmotion credits deducted\n* `subscription_created`\
                \ - Sent when a new subscription is created.\n* `subscription_created_with_backdating`\
                \ - Sent when a new subscription is created with backdating.\n* `subscription_started`\
                \ - Sent when a 'future' subscription gets started at the scheduled\
                \ date.\n* `subscription_trial_end_reminder` - Sent when the customer's\
                \ trial period is about to end.\n* `subscription_activated` - Sent\
                \ after the subscription has been moved from trial to active state\n\
                * `subscription_activated_with_backdating` - Sent after the subscription\
                \ changes to `active` from another `status`, while the change is backdated.\n\
                * `subscription_changed` - Sent after the subscription's recurring\
                \ items have been changed\n* `subscription_trial_extended` - Trial\
                \ Extension\n* `mrr_updated` - Sent when either of MRR or CMRR of\
                \ a subscription changes\n* `subscription_changed_with_backdating`\
                \ - Sent after the subscription's recurring items have been changed\
                \ with backdated date\n* `subscription_cancellation_scheduled` - Sent\
                \ when subscription is scheduled to cancel at end of current term\n\
                * `subscription_cancellation_reminder` - Sent when the customer's\
                \ subscription is nearing it's scheduled cancellation date.\n* `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'.\n* `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'.\n* `subscription_reactivated`\
                \ - Sent when the subscription is moved from cancelled state to active\
                \ or in_trial state\n* `subscription_reactivated_with_backdating`\
                \ - Sent when the subscription is moved from cancelled state to active\
                \ or in_trial state with past date\n* `subscription_renewed` - Sent\
                \ when the subscription is renewed from the current term.\n* `subscription_items_renewed`\
                \ - Sent when one or more Subscription Items are renewed\n* `subscription_scheduled_cancellation_removed`\
                \ - Sent when scheduled cancellation is removed for the subscription.\n\
                * `subscription_changes_scheduled` - Sent when subscription changes\
                \ are scheduled for later. Changes will be applied at the end of current\
                \ term.\n* `subscription_scheduled_changes_removed` - Sent when scheduled\
                \ change for the subscription is removed.\n* `subscription_shipping_address_updated`\
                \ - Triggered when shipping address is added or updated for a subscription.\n\
                * `subscription_deleted` - Sent when a subscription has been deleted\n\
                * `subscription_paused` - Sent when the subscription is paused.\n\
                * `subscription_pause_scheduled` - Sent when the subscription is scheduled\
                \ to pause.\n* `subscription_scheduled_pause_removed` - Triggered\
                \ when scheduled pause is removed for the subscription.\n* `subscription_resumed`\
                \ - Sent when the subscription is moved from paused state to active\
                \ state\n* `subscription_resumption_scheduled` - Triggered when the\
                \ subscription resumption is scheduled.\n* `subscription_scheduled_resumption_removed`\
                \ - Triggered when scheduled resumption is removed for the subscription.\n\
                * `subscription_advance_invoice_schedule_added` - Triggered when advance\
                \ invoice is scheduled for a subscription.\n* `subscription_advance_invoice_schedule_updated`\
                \ - Triggered when scheduled advance invoice is updated for a subscription.\n\
                * `subscription_advance_invoice_schedule_removed` - Triggered when\
                \ scheduled advance invoice is removed for a subscription.\n* `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.\n* `pending_invoice_updated`\
                \ - Event triggered when the option \"Notify and wait to close invoices\"\
                \ is enabled, and the 'Pending' invoice is updated.\n* `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.\n\
                * `invoice_generated_with_backdating` - Event triggered when a new\
                \ invoice is generated with past date as invoice date.\n* `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.\n* `invoice_deleted` - Event triggered\
                \ when an invoice is deleted.\n* `credit_note_created` - Sent when\
                \ a credit note is created\n* `credit_note_created_with_backdating`\
                \ - Sent when a credit note is created with past date as credit note\
                \ date\n* `credit_note_updated` - Sent when a credit note is updated\n\
                * `credit_note_deleted` - Sent when a credit note is deleted\n* `einvoice_created`\
                \ - Triggered when an e-invoice is created for an invoice or credit\
                \ note.\n* `einvoice_updated` - Triggered when an e-invoice is updated\
                \ (for example status or provider response changes).\n* `payment_schedules_created`\
                \ - Event triggered when new payment schedules are created for an\
                \ invoice\n* `payment_schedules_updated` - Event triggered when payment\
                \ schedules are updated for an invoice\n* `payment_schedule_scheme_created`\
                \ - Event triggered when a new payment schedule scheme is created\n\
                * `payment_schedule_scheme_deleted` - Event triggered when a payment\
                \ schedule scheme is deleted\n* `subscription_renewal_reminder` -\
                \ Sent before each subscription's renewal based on plan's period\n\
                * `add_usages_reminder` - Sent every month day before renewal date\
                \ of plan's period\n* `payment_due_reminder` - Sent after scheduled\
                \ days of payment failure\n* `transaction_created` - Triggered when\
                \ a transaction is recorded\n* `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.\n* `transaction_deleted` - Triggered\
                \ when a transaction is deleted. \n* `payment_succeeded` - Sent when\
                \ the payment is successfully collected\n* `payment_failed` - Sent\
                \ when attempt to charge customer's credit card fails\n* `dunning_updated`\
                \ - Sent when dunning is paused for an invoice\n* `payment_refunded`\
                \ - Sent when a payment refund is made\n* `payment_initiated` - Sent\
                \ when a payment is initiated via direct debit\n* `refund_initiated`\
                \ - Sent when a refund is initiated via direct debit\n* `netd_payment_due_reminder`\
                \ - **(Deprecated)** Sent when a invoice's due period is about to\
                \ end\n* `authorization_succeeded` - Triggered when a authorization\
                \ transaction is created.\n* `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.\n* `card_added` - Sent when a card\
                \ is added for a customer.\n* `card_updated` - Sent when the card\
                \ is updated for a customer.\n* `card_expiry_reminder` - Sent when\
                \ the customer's credit card is expiring soon. Sent 30 days before\
                \ the expiry date.\n* `card_expired` - Sent when a card for a customer\
                \ is expired\n* `card_deleted` - Sent when a card is deleted for a\
                \ customer\n* `payment_source_added` - Sent when a payment source\
                \ is added for a customer.\n* `payment_source_updated` - Sent when\
                \ the payment source is updated for a customer or when role is assigned\
                \ to the payment source.\n* `payment_source_deleted` - Sent when a\
                \ payment source is deleted for a customer\n* `payment_source_expiring`\
                \ - Sent when the customer's payment source is expiring soon. Sent\
                \ 30 days before the expiry date.\n* `payment_source_expired` - Sent\
                \ when a payment source for a customer is expired\n* `payment_source_locally_deleted`\
                \ - Sent when a payment source for a customer removed from Chargebee\n\
                * `virtual_bank_account_added` - Sent when a virtual bank account\
                \ is added for a customer.\n* `virtual_bank_account_updated` - Sent\
                \ when the virtual bank account is updated for a customer.\n* `virtual_bank_account_deleted`\
                \ - Sent when a virtual bank account is deleted for a customer.\n\
                * `token_created` - Sent when a Token is created\n* `token_consumed`\
                \ - Sent when a Token is consumed\n* `token_expired` - Sent when a\
                \ Token is expired\n* `unbilled_charges_created` - Triggered when\
                \ unbilled charges are created\n* `unbilled_charges_voided` - Triggered\
                \ when unbilled charges are voided\n* `unbilled_charges_deleted` -\
                \ Triggered when unbilled charges are deleted\n* `unbilled_charges_invoiced`\
                \ - Triggered when unbilled charges are invoiced\n* `order_created`\
                \ - Triggered when order is created\n* `order_updated` - Triggered\
                \ when order is updated\n* `order_cancelled` - Triggered when order\
                \ is cancelled\n* `order_delivered` - Triggered when order is marked\
                \ as delivered\n* `order_returned` - Triggered when order is marked\
                \ as returned\n* `order_ready_to_process` - Triggered when order reaches\
                \ it's order date\n* `order_ready_to_ship` - Triggered when order\
                \ reaches it's shipping date\n* `order_deleted` - Triggered when order\
                \ is deleted\n* `order_resent` - Triggered when order is resent\n\
                * `quote_created` - Triggered when quote is created\n* `quote_updated`\
                \ - Triggered when quote is updated\n* `quote_deleted` - Triggered\
                \ when quote is deleted\n* `tax_withheld_recorded` - Triggered when\
                \ a tax withheld is recorded for an invoice\n* `tax_withheld_deleted`\
                \ - Triggered when a tax withheld is deleted\n* `tax_withheld_refunded`\
                \ - Sent when a tax withheld refund is made\n* `gift_scheduled` -\
                \ Triggered when a new gift is created\n* `gift_unclaimed` - Triggered\
                \ when a new gift is unclaimed and is ready to be claimed\n* `gift_claimed`\
                \ - Triggered when a gift is claimed\n* `gift_expired` - Triggered\
                \ when a gift expires\n* `gift_cancelled` - Triggered when a gift\
                \ is cancelled.\n* `gift_updated` - Triggered when a gift is updated\n\
                * `hierarchy_created` - Triggered when a hierarchy is created\n* `hierarchy_deleted`\
                \ - Triggered when a hierarchy is deleted\n* `payment_intent_created`\
                \ - Sent when a Payment intent is created\n* `payment_intent_updated`\
                \ - Sent when a Payment intent is updated\n* `contract_term_created`\
                \ - Triggered when new contract term is created\n* `contract_term_renewed`\
                \ - Triggered when new contract term is renewed\n* `contract_term_terminated`\
                \ - Triggered when contract term is terminated\n* `contract_term_completed`\
                \ - Triggered when contract term is completed\n* `contract_term_cancelled`\
                \ - Triggered when contract term is cancelled\n* `item_family_created`\
                \ - Triggered when an item family is created\n* `item_family_updated`\
                \ - Triggered when an item family is updated\n* `item_family_deleted`\
                \ - Triggered when an item family is deleted\n* `item_created` - Triggered\
                \ when an item is created\n* `item_updated` - Triggered when an item\
                \ is updated\n* `item_deleted` - Triggered when an item is deleted\n\
                * `item_price_created` - Triggered when an item price is created\n\
                * `item_price_updated` - Triggered when an item price is updated\n\
                * `item_price_deleted` - Triggered when an item price is deleted\n\
                * `attached_item_created` - Triggered when an Attached item is created\n\
                * `attached_item_updated` - Triggered when an Attached item is updated\n\
                * `attached_item_deleted` - Triggered when an Attached item is deleted\n\
                * `differential_price_created` - Triggered when a differential price\
                \ is created\n* `differential_price_updated` - Triggered when a differential\
                \ price is updated\n* `differential_price_deleted` - Triggered when\
                \ a differential price is deleted\n* `feature_created` - Triggered\
                \ when a feature is created.\n* `feature_updated` - Triggered when\
                \ an feature is updated\n* `feature_deleted` - Triggered when a feature\
                \ is deleted\n* `feature_activated` - Triggered when a feature `status`\
                \ transitions to `active` for the first time.\n* `feature_reactivated`\
                \ - Triggered when a feature `status` transitions to `active` for\
                \ the second time or more.\n* `feature_archived` - Triggered when\
                \ an feature is archived\n* `item_entitlements_updated` - Triggered\
                \ when item entitlements are updated to a feature\n* `entitlement_overrides_updated`\
                \ - Triggered when an override entitlement is updated\n* `entitlement_overrides_removed`\
                \ - Triggered when an override entitlement is removed\n* `item_entitlements_removed`\
                \ - Triggered when item entitlements are removed for a feature\n*\
                \ `entitlement_overrides_auto_removed` - Triggered when Subscription\
                \ entitlements overrides for a feature are auto removed after expiry\n\
                * `subscription_entitlements_created` - Triggered when subscription\
                \ entitlements are created for a new subscription\n* `subscription_entitlements_updated`\
                \ - Triggered when subscription entitlements are updated due to the\
                \ subscription change event\n* `business_entity_created` - Sent when\
                \ a business entity is created. \n* `business_entity_updated` - Sent\
                \ when a business entity is updated. \n* `business_entity_deleted`\
                \ - Sent when a business entity is deleted. \n* `customer_business_entity_changed`\
                \ - Sent when a customer's business entity is changed.\n* `subscription_business_entity_changed`\
                \ - Sent when a subscription's business entity is changed. \n* `payment_source_business_entity_changed`\
                \ - Sent when a payment source's business entity is changed.\n* `purchase_created`\
                \ - Triggered when purchase action is completed successfully\n* `voucher_created`\
                \ - Triggered when a payment voucher is created\n* `voucher_expired`\
                \ - Triggered when a payment voucher is expired\n* `voucher_create_failed`\
                \ - Triggered when a payment voucher creation is failed\n* `product_created`\
                \ - **(Deprecated)** Triggered when the product create is completed\
                \ successfully\n* `product_updated` - **(Deprecated)** Triggered when\
                \ the product update is completed successfully\n* `product_deleted`\
                \ - **(Deprecated)** Triggered when the product delete is completed\
                \ successfully\n* `variant_created` - **(Deprecated)** Triggered when\
                \ product variant create completed successfully\n* `variant_updated`\
                \ - **(Deprecated)** Triggered when product variant update completed\
                \ successfully\n* `variant_deleted` - **(Deprecated)** Triggered when\
                \ product variant delete completed successfully\n* `item_price_entitlements_updated`\
                \ - Triggered when item Price entitlements are updated to a feature\n\
                * `item_price_entitlements_removed` - Triggered when item price entitlements\
                \ are removed for a feature\n* `subscription_ramp_created` - Triggered\
                \ when a subscription ramp is created.\n* `subscription_ramp_deleted`\
                \ - Triggered when a subscription ramp is deleted.\n* `subscription_ramp_applied`\
                \ - Triggered when a subscription ramp is applied.\n* `subscription_ramp_drafted`\
                \ - Triggered when a subscription ramp is moved to draft status.\n\
                * `subscription_ramp_updated` - Triggered when a subscription ramp\
                \ is updated.\n* `price_variant_created` - Triggered when a price\
                \ variant is created.\n* `price_variant_updated` - Triggered when\
                \ a price variant is updated.\n* `price_variant_deleted` - Triggered\
                \ when a price variant is deleted.\n* `customer_entitlements_updated`\
                \ - Triggered when entitlements for the list of customers got updated.\n\
                * `subscription_moved_in` - Triggered when a subscription moved from\
                \ other customer\n* `subscription_moved_out` - Triggered when a subscription\
                \ moved to other customer\n* `subscription_movement_failed` - Triggered\
                \ when a subscription movement failed\n* `omnichannel_subscription_created`\
                \ - Triggered when an omnichannel subscription is created\n* `omnichannel_subscription_item_renewed`\
                \ - Triggered when an omnichannel subscription item is renewed\n*\
                \ `omnichannel_subscription_item_downgrade_scheduled` - **(Deprecated)**\
                \ Triggered when an omnichannel subscription item is downgrade is\
                \ scheduled\n* `omnichannel_subscription_item_scheduled_downgrade_removed`\
                \ - **(Deprecated)** Triggered when an omnichannel subscription item\
                \ scheduled downgrade is removed\n* `omnichannel_subscription_item_downgraded`\
                \ - Triggered when an omnichannel subscription item is downgraded\n\
                * `omnichannel_subscription_item_expired` - Triggered when an omnichannel\
                \ subscription item is expired\n* `omnichannel_subscription_item_cancellation_scheduled`\
                \ - Triggered when an omnichannel subscription item is scheduled for\
                \ cancellation\n* `omnichannel_subscription_item_scheduled_cancellation_removed`\
                \ - Triggered when an omnichannel subscription item scheduled cancellation\
                \ is removed\n* `omnichannel_subscription_item_resubscribed` - Triggered\
                \ when an omnichannel subscription item is resubscribed\n* `omnichannel_subscription_item_upgraded`\
                \ - Triggered when an omnichannel subscription item is upgraded\n\
                * `omnichannel_subscription_item_cancelled` - Triggered when an omnichannel\
                \ subscription item is cancelled\n* `omnichannel_subscription_imported`\
                \ - Triggered when an omnichannel subscription item is imported\n\
                * `omnichannel_subscription_item_grace_period_started` - Triggered\
                \ when an omnichannel subscription item's grace period has started\n\
                * `omnichannel_subscription_item_grace_period_expired` - Triggered\
                \ when an omnichannel subscription item's grace period has expired\n\
                * `omnichannel_subscription_item_dunning_started` - Triggered when\
                \ an omnichannel subscription item's dunning has started\n* `omnichannel_subscription_item_dunning_expired`\
                \ - Triggered when an omnichannel subscription item's dunning has\
                \ expired\n* `rule_created` - Triggered when a rule is created\n*\
                \ `rule_updated` - Triggered when a rule is updated\n* `rule_deleted`\
                \ - Triggered when a rule is deleted\n* `record_purchase_failed` -\
                \ Triggered when an omnichannel record purchase is failed\n* `omnichannel_subscription_item_change_scheduled`\
                \ - Triggered when an omnichannel subscription item change is scheduled\n\
                * `omnichannel_subscription_item_scheduled_change_removed` - Triggered\
                \ when an omnichannel subscription item scheduled change is removed\n\
                * `omnichannel_subscription_item_reactivated` - Triggered when an\
                \ omnichannel subscription item's refund is reversed\n* `sales_order_created`\
                \ - Triggered when sales order is created\n* `sales_order_updated`\
                \ - Triggered when sales order is updated\n* `omnichannel_subscription_item_changed`\
                \ - Triggered when an omnichannel subscription item is changed\n*\
                \ `omnichannel_subscription_item_paused` - Triggered when an omnichannel\
                \ subscription item is paused\n* `omnichannel_subscription_item_resumed`\
                \ - Triggered when an omnichannel subscription item is resumed\n*\
                \ `omnichannel_one_time_order_created` - Triggered when an omnichannel\
                \ one time order is created\n* `omnichannel_one_time_order_item_cancelled`\
                \ - Triggered when an omnichannel one time order item is cancelled\n\
                * `usage_file_ingested` - Triggered when a usage file is ingested\n\
                * `omnichannel_subscription_item_pause_scheduled` - Triggered when\
                \ an omnichannel subscription item scheduled for pause\n* `omnichannel_subscription_moved_in`\
                \ - Triggered when an omnichannel subscription is moved into another\
                \ customer\n* `omnichannel_transaction_created` - Triggered when an\
                \ omnichannel transaction is created\n* `alert_status_changed` - Triggered\
                \ when the status for an alert changes\n* `omnichannel_subscription_item_updated`\
                \ - Triggered when an omnichannel subscription item is updated\n*\
                \ `omnichannel_subscription_item_recovered` - Triggered when an omnichannel\
                \ subscription item is recovered from grace period or dunning\n* `omnichannel_subscription_item_mrr_updated`\
                \ - Triggered when an omnichannel subscription item's MRR is updated\n\
                * `ledger_account_balance_updated` - Triggered when a ledger account\
                \ balance changes for a subscription unit.\n* `grant_blocks_created`\
                \ - Triggered when one or more grant blocks are created for a subscription\
                \ unit.\n* `grant_blocks_updated` - Triggered when one or more grant\
                \ blocks are updated for a subscription unit.\n* `ledger_updated`\
                \ - Triggered when a batch of ledger operations is persisted for a\
                \ subscription unit.\n* `business_rule_created` - Triggered when a\
                \ business rule is created\n* `business_rule_updated` - Triggered\
                \ when a business rule is updated\n* `business_rule_activated` - Triggered\
                \ when a business rule is activated\n* `business_rule_deactivated`\
                \ - Triggered when a business rule is deactivated\n* `business_rule_deleted`\
                \ - Triggered when a business rule is deleted\n* `business_rule_released`\
                \ - Triggered when a business rule is released\n* `vault_token_created`\
                \ - Triggered when a payment method is tokenized and stored in the\
                \ vault.\n* `vault_token_updated` - Triggered when a vaulted payment\
                \ method is updated.\n* `vault_token_deleted` - Triggered when a vaulted\
                \ payment method is deleted from the vault.\n* `business_rules_applied`\
                \ - Triggered when rules are applied to any entity.\n* `business_ruleset_created`\
                \ - Triggered when a business ruleset is created\n* `business_ruleset_updated`\
                \ - Triggered when a business ruleset is updated\n* `business_ruleset_activated`\
                \ - Triggered when a business ruleset is activated\n* `business_ruleset_deactivated`\
                \ - Triggered when a business ruleset is deactivated\n* `business_ruleset_deleted`\
                \ - Triggered when a business ruleset is deleted"
              enum:
              - 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
              - einvoice_created
              - einvoice_updated
              - payment_schedules_created
              - payment_schedules_updated
              - payment_schedule_scheme_created
              - payment_schedule_scheme_deleted
              - subscription_renewal_reminder
              - add_usages_reminder
              - payment_due_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
              - item_family_created
              - item_family_updated
              - item_family_deleted
              - item_created
              - item_updated
              - item_deleted
              - item_price_created
              - item_price_updated
              - item_price_deleted
              - attached_item_created
              - attached_item_updated
              - attached_item_deleted
              - differential_price_created
              - differential_price_updated
              - differential_price_deleted
              - feature_created
              - feature_updated
              - feature_deleted
              - feature_activated
              - feature_reactivated
              - feature_archived
              - item_entitlements_updated
              - entitlement_overrides_updated
              - entitlement_overrides_removed
              - item_entitlements_removed
              - entitlement_overrides_auto_removed
              - subscription_entitlements_created
              - subscription_entitlements_updated
              - business_entity_created
              - business_entity_updated
              - business_entity_deleted
              - customer_business_entity_changed
              - subscription_business_entity_changed
              - payment_source_business_entity_changed
              - purchase_created
              - voucher_created
              - voucher_expired
              - voucher_create_failed
              - item_price_entitlements_updated
              - item_price_entitlements_removed
              - subscription_ramp_created
              - subscription_ramp_deleted
              - subscription_ramp_applied
              - subscription_ramp_drafted
              - subscription_ramp_updated
              - price_variant_created
              - price_variant_updated
              - price_variant_deleted
              - customer_entitlements_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
              - omnichannel_subscription_moved_in
              - omnichannel_transaction_created
              - alert_status_changed
              - omnichannel_subscription_item_updated
              - omnichannel_subscription_item_recovered
              - omnichannel_subscription_item_mrr_updated
              - ledger_account_balance_updated
              - grant_blocks_created
              - grant_blocks_updated
              - ledger_updated
              - business_rule_created
              - business_rule_updated
              - business_rule_activated
              - business_rule_deactivated
              - business_rule_deleted
              - business_rule_released
              - vault_token_created
              - vault_token_updated
              - vault_token_deleted
              - business_rules_applied
              - business_ruleset_created
              - business_ruleset_updated
              - business_ruleset_activated
              - business_ruleset_deactivated
              - business_ruleset_deleted
              pattern: "^\\[(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|einvoice_created|einvoice_updated|payment_schedules_created|payment_schedules_updated|payment_schedule_scheme_created|payment_schedule_scheme_deleted|subscription_renewal_reminder|add_usages_reminder|payment_due_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|item_family_created|item_family_updated|item_family_deleted|item_created|item_updated|item_deleted|item_price_created|item_price_updated|item_price_deleted|attached_item_created|attached_item_updated|attached_item_deleted|differential_price_created|differential_price_updated|differential_price_deleted|feature_created|feature_updated|feature_deleted|feature_activated|feature_reactivated|feature_archived|item_entitlements_updated|entitlement_overrides_updated|entitlement_overrides_removed|item_entitlements_removed|entitlement_overrides_auto_removed|subscription_entitlements_created|subscription_entitlements_updated|business_entity_created|business_entity_updated|business_entity_deleted|customer_business_entity_changed|subscription_business_entity_changed|payment_source_business_entity_changed|purchase_created|voucher_created|voucher_expired|voucher_create_failed|product_created|product_updated|product_deleted|variant_created|variant_updated|variant_deleted|item_price_entitlements_updated|item_price_entitlements_removed|subscription_ramp_created|subscription_ramp_deleted|subscription_ramp_applied|subscription_ramp_drafted|subscription_ramp_updated|price_variant_created|price_variant_updated|price_variant_deleted|customer_entitlements_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|omnichannel_subscription_moved_in|omnichannel_transaction_created|alert_status_changed|omnichannel_subscription_item_updated|omnichannel_subscription_item_recovered|omnichannel_subscription_item_mrr_updated|ledger_account_balance_updated|grant_blocks_created|grant_blocks_updated|ledger_updated|business_rule_created|business_rule_updated|business_rule_activated|business_rule_deactivated|business_rule_deleted|business_rule_released|vault_token_created|vault_token_updated|vault_token_deleted|business_rules_applied|business_ruleset_created|business_ruleset_updated|business_ruleset_activated|business_ruleset_deactivated|business_ruleset_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|einvoice_created|einvoice_updated|payment_schedules_created|payment_schedules_updated|payment_schedule_scheme_created|payment_schedule_scheme_deleted|subscription_renewal_reminder|add_usages_reminder|payment_due_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|item_family_created|item_family_updated|item_family_deleted|item_created|item_updated|item_deleted|item_price_created|item_price_updated|item_price_deleted|attached_item_created|attached_item_updated|attached_item_deleted|differential_price_created|differential_price_updated|differential_price_deleted|feature_created|feature_updated|feature_deleted|feature_activated|feature_reactivated|feature_archived|item_entitlements_updated|entitlement_overrides_updated|entitlement_overrides_removed|item_entitlements_removed|entitlement_overrides_auto_removed|subscription_entitlements_created|subscription_entitlements_updated|business_entity_created|business_entity_updated|business_entity_deleted|customer_business_entity_changed|subscription_business_entity_changed|payment_source_business_entity_changed|purchase_created|voucher_created|voucher_expired|voucher_create_failed|product_created|product_updated|product_deleted|variant_created|variant_updated|variant_deleted|item_price_entitlements_updated|item_price_entitlements_removed|subscription_ramp_created|subscription_ramp_deleted|subscription_ramp_applied|subscription_ramp_drafted|subscription_ramp_updated|price_variant_created|price_variant_updated|price_variant_deleted|customer_entitlements_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|omnichannel_subscription_moved_in|omnichannel_transaction_created|alert_status_changed|omnichannel_subscription_item_updated|omnichannel_subscription_item_recovered|omnichannel_subscription_item_mrr_updated|ledger_account_balance_updated|grant_blocks_created|grant_blocks_updated|ledger_updated|business_rule_created|business_rule_updated|business_rule_activated|business_rule_deactivated|business_rule_deleted|business_rule_released|vault_token_created|vault_token_updated|vault_token_deleted|business_rules_applied|business_ruleset_created|business_ruleset_updated|business_ruleset_activated|business_ruleset_deactivated|business_ruleset_deleted))*\\\
                ]$"
              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_not\] = "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\[after\] = "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:
      tags:
      - events
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - 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: |
                      Resource object representing event
                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:
      tags:
      - comments
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing comment
                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:
      tags:
      - comments
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing comment
                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:
      tags:
      - comments
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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
          * invoice - Invoice description
          * business_entity - Entity that represents item of type business entity
          * plan - Entity that represents a subscription plan
          * price_variant - Entity that represents a price variant
          * 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
          - item_family
          - item
          - item_price
          - price_variant
          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\[on\] = "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:
      tags:
      - comments
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
                    * invoice - Invoice description
                    * business_entity - Entity that represents item of type business entity
                    * plan - Entity that represents a subscription plan
                    * price_variant - Entity that represents a price variant
                    * 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
                  - item_family
                  - item
                  - item_price
                  - price_variant
                  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: |
                      Resource object representing comment
                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:
      tags:
      - portal_sessions
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing portal_session
                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:
      tags:
      - portal_sessions
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing portal_session
                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:
      tags:
      - portal_sessions
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing portal_session
                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:
      tags:
      - portal_sessions
      summary: Retrieve a portal session
      description: |
        This API retrieves a portal session using `portal_session_id`
        as a path parameter.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing portal_session
                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:
      tags:
      - site_migration_details
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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\] = "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
                * `credit_note` - Credit note
                * `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
                * `credit_note` - Credit note
                * `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
                * `credit_note` - Credit note
                * `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
                * `credit_note` - Credit note
                * `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:
      tags:
      - resource_migrations
      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})))?::)))))$"
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  resource_migration:
                    $ref: "#/components/schemas/ResourceMigration"
                    description: |
                      Resource object representing resource_migration
                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:
      tags:
      - time_machines
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  time_machine:
                    $ref: "#/components/schemas/TimeMachine"
                    description: |
                      Resource object representing time_machine
                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:
      tags:
      - time_machines
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing time_machine
                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:
      tags:
      - time_machines
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Resource object representing time_machine
                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:
      tags:
      - exports
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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 - Provides the full set of data for the customers in multiple `.csv` files.
                    * import_friendly_data - Provides a `.csv` file whose columns match the [`customer`](/docs/api/customers/customer-object) schema. This file format can be readily imported through the UI by using [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 unique ID of the
                    [business entity](/docs/api/getting-started)
                    of this subscription. This is always the same as the
                    [business entity](/docs/api/subscriptions/subscription-object#customer_id)
                    of the customer.

                    **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. Possible values are : taxable, exempt, zero_rated.
                      example: taxable
                      properties:
                        is:
                          type: string
                          description: |
                            * `taxable` - Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html). 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` -
                              * Customer is exempted from tax. When using Chargebee's native [Taxes](https://www.chargebee.com/docs/tax.html) feature or when using the [TaxJar integration](https://www.chargebee.com/docs/taxjar.html), no other action is needed.
                              * However, when using our [Avalara integration](https://www.chargebee.com/docs/avalara.html), optionally, specify `entity_code` or `exempt_number` attributes if you use Chargebee's [AvaTax for Sales](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption) or specify `exemption_details` attribute if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. Tax may still be applied by Avalara for certain values of `entity_code`/`exempt_number`/`exemption_details` based on the state/region/province of the taxable address.
                            * `zero_rated` - With [Chargebee Taxes](https://www.chargebee.com/docs/tax.html), otherwise taxable line items for the customer are taxed at 0%. These line items have `is_taxed` set to `true`, the tax rate and tax amount set to `0`, and `tax_exempt_reason` set to `zero_rated`. Unlike `exempt`, this option follows the taxable tax path at a zero rate.
                          enum:
                          - taxable
                          - exempt
                          - zero_rated
                          example: null
                        is_not:
                          type: string
                          description: |
                            * `taxable` - Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html). 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` -
                              * Customer is exempted from tax. When using Chargebee's native [Taxes](https://www.chargebee.com/docs/tax.html) feature or when using the [TaxJar integration](https://www.chargebee.com/docs/taxjar.html), no other action is needed.
                              * However, when using our [Avalara integration](https://www.chargebee.com/docs/avalara.html), optionally, specify `entity_code` or `exempt_number` attributes if you use Chargebee's [AvaTax for Sales](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption) or specify `exemption_details` attribute if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. Tax may still be applied by Avalara for certain values of `entity_code`/`exempt_number`/`exemption_details` based on the state/region/province of the taxable address.
                            * `zero_rated` - With [Chargebee Taxes](https://www.chargebee.com/docs/tax.html), otherwise taxable line items for the customer are taxed at 0%. These line items have `is_taxed` set to `true`, the tax rate and tax amount set to `0`, and `tax_exempt_reason` set to `zero_rated`. Unlike `exempt`, this option follows the taxable tax path at a zero rate.
                          enum:
                          - taxable
                          - exempt
                          - zero_rated
                          example: null
                        in:
                          type: string
                          description: |
                            * `taxable` - Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html). 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` -
                              * Customer is exempted from tax. When using Chargebee's native [Taxes](https://www.chargebee.com/docs/tax.html) feature or when using the [TaxJar integration](https://www.chargebee.com/docs/taxjar.html), no other action is needed.
                              * However, when using our [Avalara integration](https://www.chargebee.com/docs/avalara.html), optionally, specify `entity_code` or `exempt_number` attributes if you use Chargebee's [AvaTax for Sales](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption) or specify `exemption_details` attribute if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. Tax may still be applied by Avalara for certain values of `entity_code`/`exempt_number`/`exemption_details` based on the state/region/province of the taxable address.
                            * `zero_rated` - With [Chargebee Taxes](https://www.chargebee.com/docs/tax.html), otherwise taxable line items for the customer are taxed at 0%. These line items have `is_taxed` set to `true`, the tax rate and tax amount set to `0`, and `tax_exempt_reason` set to `zero_rated`. Unlike `exempt`, this option follows the taxable tax path at a zero rate.
                          enum:
                          - taxable
                          - exempt
                          - zero_rated
                          pattern: "^\\[(taxable|exempt|zero_rated)(,(taxable|exempt|zero_rated))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            * `taxable` - Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html). 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` -
                              * Customer is exempted from tax. When using Chargebee's native [Taxes](https://www.chargebee.com/docs/tax.html) feature or when using the [TaxJar integration](https://www.chargebee.com/docs/taxjar.html), no other action is needed.
                              * However, when using our [Avalara integration](https://www.chargebee.com/docs/avalara.html), optionally, specify `entity_code` or `exempt_number` attributes if you use Chargebee's [AvaTax for Sales](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption) or specify `exemption_details` attribute if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. Tax may still be applied by Avalara for certain values of `entity_code`/`exempt_number`/`exemption_details` based on the state/region/province of the taxable address.
                            * `zero_rated` - With [Chargebee Taxes](https://www.chargebee.com/docs/tax.html), otherwise taxable line items for the customer are taxed at 0%. These line items have `is_taxed` set to `true`, the tax rate and tax amount set to `0`, and `tax_exempt_reason` set to `zero_rated`. Unlike `exempt`, this option follows the taxable tax path at a zero rate.
                          enum:
                          - taxable
                          - exempt
                          - zero_rated
                          pattern: "^\\[(taxable|exempt|zero_rated)(,(taxable|exempt|zero_rated))*\\\
                            ]$"
                          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: |
                        To filter based on `updated_at`.
                        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 `sort_by`
                        input parameter as `updated_at`
                        for a faster response.
                      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/billing/2.0/usage-based-billing/metered_billing#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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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: |
                      Resource object representing export
                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/attached_items:
    post:
      tags:
      - exports
      summary: Export attached items
      description: |
        This API triggers export of attached item data. The exported zip file contains CSV files with attached item-related data.
      operationId: export_attached_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                item_type:
                  type: object
                  deprecated: false
                  description: |
                    optional, enumerated string filter

                    To filter based on the type of of the attached item. Possible values are : `addon`
                    , `charge`.
                    Possible values are : plan, addon, charge.

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

                    **Example →**
                    *item_type\[is_not\] = "plan"*
                  example: plan
                  properties:
                    is:
                      type: string
                      description: |
                        * `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.
                        * `addon` - A recurring component that can be added to a subscription in addition to its plan.
                        * `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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.
                      enum:
                      - plan
                      - addon
                      - charge
                      example: null
                    is_not:
                      type: string
                      description: |
                        * `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.
                        * `addon` - A recurring component that can be added to a subscription in addition to its plan.
                        * `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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.
                      enum:
                      - plan
                      - addon
                      - charge
                      example: null
                    in:
                      type: string
                      description: |
                        * `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.
                        * `addon` - A recurring component that can be added to a subscription in addition to its plan.
                        * `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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.
                      enum:
                      - plan
                      - addon
                      - charge
                      pattern: "^\\[(plan|addon|charge)(,(plan|addon|charge))*\\]$"
                      example: null
                    not_in:
                      type: string
                      description: |
                        * `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.
                        * `addon` - A recurring component that can be added to a subscription in addition to its plan.
                        * `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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.
                      enum:
                      - plan
                      - addon
                      - charge
                      pattern: "^\\[(plan|addon|charge)(,(plan|addon|charge))*\\]$"
                      example: null
                attached_item:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for attached_item
                  properties:
                    id:
                      type: object
                      deprecated: false
                      description: |
                        Filter attached items based on their id.
                      example: bec0c324-adb6-44d3-ad4f-694f449be97c
                      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
                    item_id:
                      type: object
                      deprecated: false
                      description: |
                        Filter attached items based on the `item_id`
                        of the item being attached.
                      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
                    type:
                      type: object
                      deprecated: false
                      description: |
                        Filter attached items based on the `type`
                        of attached item. Possible values are : `recommended`
                        , `mandatory`
                        , `optional`
                        .
                      example: mandatory
                      properties:
                        is:
                          type: string
                          description: |
                            * `recommended` - The addon is recommended to go with the plan-item when using [Checkout](https://www.chargebee.com/docs/2.0/configure-inapp.html#fundamental-settings_recommending-addons-in-checkout) or [Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html#allow-change-subscription).
                            * `mandatory` - The addon is attached automatically to the subscription for the plan-item unless [explicitly removed](./subscriptions?prod_cat_ver=2) via API.
                            * `optional` - The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a `quantity` and `billing_cycles` for the addon, for when it is applied to subscriptions with the plan.
                          enum:
                          - recommended
                          - mandatory
                          - optional
                          example: null
                        is_not:
                          type: string
                          description: |
                            * `recommended` - The addon is recommended to go with the plan-item when using [Checkout](https://www.chargebee.com/docs/2.0/configure-inapp.html#fundamental-settings_recommending-addons-in-checkout) or [Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html#allow-change-subscription).
                            * `mandatory` - The addon is attached automatically to the subscription for the plan-item unless [explicitly removed](./subscriptions?prod_cat_ver=2) via API.
                            * `optional` - The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a `quantity` and `billing_cycles` for the addon, for when it is applied to subscriptions with the plan.
                          enum:
                          - recommended
                          - mandatory
                          - optional
                          example: null
                        in:
                          type: string
                          description: |
                            * `recommended` - The addon is recommended to go with the plan-item when using [Checkout](https://www.chargebee.com/docs/2.0/configure-inapp.html#fundamental-settings_recommending-addons-in-checkout) or [Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html#allow-change-subscription).
                            * `mandatory` - The addon is attached automatically to the subscription for the plan-item unless [explicitly removed](./subscriptions?prod_cat_ver=2) via API.
                            * `optional` - The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a `quantity` and `billing_cycles` for the addon, for when it is applied to subscriptions with the plan.
                          enum:
                          - recommended
                          - mandatory
                          - optional
                          pattern: "^\\[(recommended|mandatory|optional)(,(recommended|mandatory|optional))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            * `recommended` - The addon is recommended to go with the plan-item when using [Checkout](https://www.chargebee.com/docs/2.0/configure-inapp.html#fundamental-settings_recommending-addons-in-checkout) or [Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html#allow-change-subscription).
                            * `mandatory` - The addon is attached automatically to the subscription for the plan-item unless [explicitly removed](./subscriptions?prod_cat_ver=2) via API.
                            * `optional` - The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a `quantity` and `billing_cycles` for the addon, for when it is applied to subscriptions with the plan.
                          enum:
                          - recommended
                          - mandatory
                          - optional
                          pattern: "^\\[(recommended|mandatory|optional)(,(recommended|mandatory|optional))*\\\
                            ]$"
                          example: null
                    charge_on_event:
                      type: object
                      deprecated: false
                      description: |
                        Indicates when the item is charged. This attribute only applies to charge-items.
                      example: subscription_creation
                      properties:
                        is:
                          type: string
                          description: |
                            * `subscription_creation` - the time of creation of the subscription.
                            * `subscription_trial_start` - the time when the trial period of the subscription begins.
                            * `plan_activation` - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                            * `subscription_activation` - the moment a subscription enters an `active` or `non-renewing` state. Also includes reactivations of canceled subscriptions.
                            * `contract_termination` - when a contract term is [terminated](./subscriptions?prod_cat_ver=2#cancel_subscription_for_items_contract_term_cancel_option).
                            * `on_demand` - Item can be charged on demand
                          enum:
                          - subscription_creation
                          - subscription_trial_start
                          - plan_activation
                          - subscription_activation
                          - contract_termination
                          - on_demand
                          example: null
                        is_not:
                          type: string
                          description: |
                            * `subscription_creation` - the time of creation of the subscription.
                            * `subscription_trial_start` - the time when the trial period of the subscription begins.
                            * `plan_activation` - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                            * `subscription_activation` - the moment a subscription enters an `active` or `non-renewing` state. Also includes reactivations of canceled subscriptions.
                            * `contract_termination` - when a contract term is [terminated](./subscriptions?prod_cat_ver=2#cancel_subscription_for_items_contract_term_cancel_option).
                            * `on_demand` - Item can be charged on demand
                          enum:
                          - subscription_creation
                          - subscription_trial_start
                          - plan_activation
                          - subscription_activation
                          - contract_termination
                          - on_demand
                          example: null
                        in:
                          type: string
                          description: |
                            * `subscription_creation` - the time of creation of the subscription.
                            * `subscription_trial_start` - the time when the trial period of the subscription begins.
                            * `plan_activation` - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                            * `subscription_activation` - the moment a subscription enters an `active` or `non-renewing` state. Also includes reactivations of canceled subscriptions.
                            * `contract_termination` - when a contract term is [terminated](./subscriptions?prod_cat_ver=2#cancel_subscription_for_items_contract_term_cancel_option).
                            * `on_demand` - Item can be charged on demand
                          enum:
                          - subscription_creation
                          - subscription_trial_start
                          - plan_activation
                          - subscription_activation
                          - contract_termination
                          - on_demand
                          pattern: "^\\[(subscription_creation|subscription_trial_start|plan_activation|subscription_activation|contract_termination|on_demand)(,(subscription_creation|subscription_trial_start|plan_activation|subscription_activation|contract_termination|on_demand))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            * `subscription_creation` - the time of creation of the subscription.
                            * `subscription_trial_start` - the time when the trial period of the subscription begins.
                            * `plan_activation` - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                            * `subscription_activation` - the moment a subscription enters an `active` or `non-renewing` state. Also includes reactivations of canceled subscriptions.
                            * `contract_termination` - when a contract term is [terminated](./subscriptions?prod_cat_ver=2#cancel_subscription_for_items_contract_term_cancel_option).
                            * `on_demand` - Item can be charged on demand
                          enum:
                          - subscription_creation
                          - subscription_trial_start
                          - plan_activation
                          - subscription_activation
                          - contract_termination
                          - on_demand
                          pattern: "^\\[(subscription_creation|subscription_trial_start|plan_activation|subscription_activation|contract_termination|on_demand)(,(subscription_creation|subscription_trial_start|plan_activation|subscription_activation|contract_termination|on_demand))*\\\
                            ]$"
                          example: null
                    updated_at:
                      type: object
                      deprecated: false
                      description: |
                        Filter attached items based on when the attached items were last 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
                    parent_item_id:
                      type: object
                      deprecated: false
                      description: |
                        The id of the plan-item to which the item is attached.
                      example: silver
                      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
                  example: null
              example: null
            encoding:
              attached_item:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  export:
                    $ref: "#/components/schemas/Export"
                    description: |
                      Resource object representing export
                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:
      tags:
      - exports
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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 [type](transactions#transaction_type) = `refund`. This value is set by Chargebee when an automated [chargeback](https://www.chargebee.com/docs/chargeback.html#chargeback-process) occurs. You can also set this explicitly when [recording a refund](transactions#record_an_offline_refund).
                            * `bank_transfer` - Bank Transfer
                            * `amazon_payments` - Amazon Payments
                            * `paypal_express_checkout` - Paypal Express Checkout
                            * `direct_debit` - Direct Debit
                            * `alipay` - Alipay
                            * `unionpay` - Unionpay
                            * `apple_pay` - Apple Pay
                            * `wechat_pay` - WeChat Pay
                            * `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
                            * `pay_to` - PayTo
                            * `faster_payments` - Faster Payments
                            * `sepa_instant_transfer` - Sepa Instant Transfer
                            * `automated_bank_transfer` - Automated Bank Transfer
                            * `klarna_pay_now` - Klarna Pay Now
                            * `online_banking_poland` - Online Banking Poland
                            * `payconiq_by_bancontact` - 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` - Stablecoin
                            * `kakao_pay` - Kakao Pay
                            * `naver_pay` - Naver Pay
                            * `revolut_pay` - Revolut Pay
                            * `cash_app_pay` - Cash App Pay
                            * `pix` - Payments made via Pix
                            * `twint` - Twint
                            * `go_pay` - Go Pay
                            * `grab_pay` - Grab Pay
                            * `pay_co` - Pay Co
                            * `after_pay` - After Pay
                            * `swish` - Swish
                            * `payme` - PayMe
                            * `klarna` - Payments made via Klarna
                            * `alipay_hk` - Alipay HK
                            * `paypay` - PayPay
                            * `gcash` - GCash
                            * `south_korean_cards` - Payments made via South Korean Cards
                            * `paynow` - Payments made via PayNow
                            * `bizum` - Payments made via Bizum
                            * `promptpay` - Payments made via PromptPay
                            * `dana` - Dana
                            * `touch_n_go` - Touch 'n Go
                            * `tamara` - Tamara
                            * `qpay` - Qpay
                            * `ovo` - OVO
                            * `momo` - MoMo
                            * `mercado_pago` - Mercado Pago
                            * `nequi` - Nequi
                            * `nupay` - NuPay
                            * `picpay` - PicPay
                            * `thai_qr` - Thai QR
                            * `blik` - BLIK
                            * `fpx` - FPX
                            * `wero` - Wero
                            * `p24` - Przelewy24 (P24)
                            * `affirm_pay` - Affirm Pay
                            * `rakuten_pay` - Rakuten Pay
                          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
                          - alipay_hk
                          - paypay
                          - gcash
                          - south_korean_cards
                          - paynow
                          - bizum
                          - promptpay
                          - dana
                          - touch_n_go
                          - tamara
                          - qpay
                          - ovo
                          - momo
                          - mercado_pago
                          - nequi
                          - nupay
                          - picpay
                          - thai_qr
                          - blik
                          - fpx
                          - wero
                          - p24
                          - affirm_pay
                          - rakuten_pay
                          example: null
                        is_not:
                          type: string
                          description: |
                            * `card` - Card
                            * `cash` - Cash
                            * `check` - Check
                            * `chargeback` - Only applicable for a transaction of [type](transactions#transaction_type) = `refund`. This value is set by Chargebee when an automated [chargeback](https://www.chargebee.com/docs/chargeback.html#chargeback-process) occurs. You can also set this explicitly when [recording a refund](transactions#record_an_offline_refund).
                            * `bank_transfer` - Bank Transfer
                            * `amazon_payments` - Amazon Payments
                            * `paypal_express_checkout` - Paypal Express Checkout
                            * `direct_debit` - Direct Debit
                            * `alipay` - Alipay
                            * `unionpay` - Unionpay
                            * `apple_pay` - Apple Pay
                            * `wechat_pay` - WeChat Pay
                            * `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
                            * `pay_to` - PayTo
                            * `faster_payments` - Faster Payments
                            * `sepa_instant_transfer` - Sepa Instant Transfer
                            * `automated_bank_transfer` - Automated Bank Transfer
                            * `klarna_pay_now` - Klarna Pay Now
                            * `online_banking_poland` - Online Banking Poland
                            * `payconiq_by_bancontact` - 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` - Stablecoin
                            * `kakao_pay` - Kakao Pay
                            * `naver_pay` - Naver Pay
                            * `revolut_pay` - Revolut Pay
                            * `cash_app_pay` - Cash App Pay
                            * `pix` - Payments made via Pix
                            * `twint` - Twint
                            * `go_pay` - Go Pay
                            * `grab_pay` - Grab Pay
                            * `pay_co` - Pay Co
                            * `after_pay` - After Pay
                            * `swish` - Swish
                            * `payme` - PayMe
                            * `klarna` - Payments made via Klarna
                            * `alipay_hk` - Alipay HK
                            * `paypay` - PayPay
                            * `gcash` - GCash
                            * `south_korean_cards` - Payments made via South Korean Cards
                            * `paynow` - Payments made via PayNow
                            * `bizum` - Payments made via Bizum
                            * `promptpay` - Payments made via PromptPay
                            * `dana` - Dana
                            * `touch_n_go` - Touch 'n Go
                            * `tamara` - Tamara
                            * `qpay` - Qpay
                            * `ovo` - OVO
                            * `momo` - MoMo
                            * `mercado_pago` - Mercado Pago
                            * `nequi` - Nequi
                            * `nupay` - NuPay
                            * `picpay` - PicPay
                            * `thai_qr` - Thai QR
                            * `blik` - BLIK
                            * `fpx` - FPX
                            * `wero` - Wero
                            * `p24` - Przelewy24 (P24)
                            * `affirm_pay` - Affirm Pay
                            * `rakuten_pay` - Rakuten Pay
                          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
                          - alipay_hk
                          - paypay
                          - gcash
                          - south_korean_cards
                          - paynow
                          - bizum
                          - promptpay
                          - dana
                          - touch_n_go
                          - tamara
                          - qpay
                          - ovo
                          - momo
                          - mercado_pago
                          - nequi
                          - nupay
                          - picpay
                          - thai_qr
                          - blik
                          - fpx
                          - wero
                          - p24
                          - affirm_pay
                          - rakuten_pay
                          example: null
                        in:
                          type: string
                          description: |
                            * `card` - Card
                            * `cash` - Cash
                            * `check` - Check
                            * `chargeback` - Only applicable for a transaction of [type](transactions#transaction_type) = `refund`. This value is set by Chargebee when an automated [chargeback](https://www.chargebee.com/docs/chargeback.html#chargeback-process) occurs. You can also set this explicitly when [recording a refund](transactions#record_an_offline_refund).
                            * `bank_transfer` - Bank Transfer
                            * `amazon_payments` - Amazon Payments
                            * `paypal_express_checkout` - Paypal Express Checkout
                            * `direct_debit` - Direct Debit
                            * `alipay` - Alipay
                            * `unionpay` - Unionpay
                            * `apple_pay` - Apple Pay
                            * `wechat_pay` - WeChat Pay
                            * `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
                            * `pay_to` - PayTo
                            * `faster_payments` - Faster Payments
                            * `sepa_instant_transfer` - Sepa Instant Transfer
                            * `automated_bank_transfer` - Automated Bank Transfer
                            * `klarna_pay_now` - Klarna Pay Now
                            * `online_banking_poland` - Online Banking Poland
                            * `payconiq_by_bancontact` - 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` - Stablecoin
                            * `kakao_pay` - Kakao Pay
                            * `naver_pay` - Naver Pay
                            * `revolut_pay` - Revolut Pay
                            * `cash_app_pay` - Cash App Pay
                            * `pix` - Payments made via Pix
                            * `twint` - Twint
                            * `go_pay` - Go Pay
                            * `grab_pay` - Grab Pay
                            * `pay_co` - Pay Co
                            * `after_pay` - After Pay
                            * `swish` - Swish
                            * `payme` - PayMe
                            * `klarna` - Payments made via Klarna
                            * `alipay_hk` - Alipay HK
                            * `paypay` - PayPay
                            * `gcash` - GCash
                            * `south_korean_cards` - Payments made via South Korean Cards
                            * `paynow` - Payments made via PayNow
                            * `bizum` - Payments made via Bizum
                            * `promptpay` - Payments made via PromptPay
                            * `dana` - Dana
                            * `touch_n_go` - Touch 'n Go
                            * `tamara` - Tamara
                            * `qpay` - Qpay
                            * `ovo` - OVO
                            * `momo` - MoMo
                            * `mercado_pago` - Mercado Pago
                            * `nequi` - Nequi
                            * `nupay` - NuPay
                            * `picpay` - PicPay
                            * `thai_qr` - Thai QR
                            * `blik` - BLIK
                            * `fpx` - FPX
                            * `wero` - Wero
                            * `p24` - Przelewy24 (P24)
                            * `affirm_pay` - Affirm Pay
                            * `rakuten_pay` - Rakuten Pay
                          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
                          - alipay_hk
                          - paypay
                          - gcash
                          - south_korean_cards
                          - paynow
                          - bizum
                          - promptpay
                          - dana
                          - touch_n_go
                          - tamara
                          - qpay
                          - ovo
                          - momo
                          - mercado_pago
                          - nequi
                          - nupay
                          - picpay
                          - thai_qr
                          - blik
                          - fpx
                          - wero
                          - p24
                          - affirm_pay
                          - rakuten_pay
                          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|alipay_hk|paypay|gcash|south_korean_cards|paynow|bizum|promptpay|dana|touch_n_go|tamara|qpay|ovo|momo|mercado_pago|nequi|nupay|picpay|thai_qr|blik|fpx|wero|p24|affirm_pay|rakuten_pay)(,(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|alipay_hk|paypay|gcash|south_korean_cards|paynow|bizum|promptpay|dana|touch_n_go|tamara|qpay|ovo|momo|mercado_pago|nequi|nupay|picpay|thai_qr|blik|fpx|wero|p24|affirm_pay|rakuten_pay))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            * `card` - Card
                            * `cash` - Cash
                            * `check` - Check
                            * `chargeback` - Only applicable for a transaction of [type](transactions#transaction_type) = `refund`. This value is set by Chargebee when an automated [chargeback](https://www.chargebee.com/docs/chargeback.html#chargeback-process) occurs. You can also set this explicitly when [recording a refund](transactions#record_an_offline_refund).
                            * `bank_transfer` - Bank Transfer
                            * `amazon_payments` - Amazon Payments
                            * `paypal_express_checkout` - Paypal Express Checkout
                            * `direct_debit` - Direct Debit
                            * `alipay` - Alipay
                            * `unionpay` - Unionpay
                            * `apple_pay` - Apple Pay
                            * `wechat_pay` - WeChat Pay
                            * `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
                            * `pay_to` - PayTo
                            * `faster_payments` - Faster Payments
                            * `sepa_instant_transfer` - Sepa Instant Transfer
                            * `automated_bank_transfer` - Automated Bank Transfer
                            * `klarna_pay_now` - Klarna Pay Now
                            * `online_banking_poland` - Online Banking Poland
                            * `payconiq_by_bancontact` - 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` - Stablecoin
                            * `kakao_pay` - Kakao Pay
                            * `naver_pay` - Naver Pay
                            * `revolut_pay` - Revolut Pay
                            * `cash_app_pay` - Cash App Pay
                            * `pix` - Payments made via Pix
                            * `twint` - Twint
                            * `go_pay` - Go Pay
                            * `grab_pay` - Grab Pay
                            * `pay_co` - Pay Co
                            * `after_pay` - After Pay
                            * `swish` - Swish
                            * `payme` - PayMe
                            * `klarna` - Payments made via Klarna
                            * `alipay_hk` - Alipay HK
                            * `paypay` - PayPay
                            * `gcash` - GCash
                            * `south_korean_cards` - Payments made via South Korean Cards
                            * `paynow` - Payments made via PayNow
                            * `bizum` - Payments made via Bizum
                            * `promptpay` - Payments made via PromptPay
                            * `dana` - Dana
                            * `touch_n_go` - Touch 'n Go
                            * `tamara` - Tamara
                            * `qpay` - Qpay
                            * `ovo` - OVO
                            * `momo` - MoMo
                            * `mercado_pago` - Mercado Pago
                            * `nequi` - Nequi
                            * `nupay` - NuPay
                            * `picpay` - PicPay
                            * `thai_qr` - Thai QR
                            * `blik` - BLIK
                            * `fpx` - FPX
                            * `wero` - Wero
                            * `p24` - Przelewy24 (P24)
                            * `affirm_pay` - Affirm Pay
                            * `rakuten_pay` - Rakuten Pay
                          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
                          - alipay_hk
                          - paypay
                          - gcash
                          - south_korean_cards
                          - paynow
                          - bizum
                          - promptpay
                          - dana
                          - touch_n_go
                          - tamara
                          - qpay
                          - ovo
                          - momo
                          - mercado_pago
                          - nequi
                          - nupay
                          - picpay
                          - thai_qr
                          - blik
                          - fpx
                          - wero
                          - p24
                          - affirm_pay
                          - rakuten_pay
                          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|alipay_hk|paypay|gcash|south_korean_cards|paynow|bizum|promptpay|dana|touch_n_go|tamara|qpay|ovo|momo|mercado_pago|nequi|nupay|picpay|thai_qr|blik|fpx|wero|p24|affirm_pay|rakuten_pay)(,(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|alipay_hk|paypay|gcash|south_korean_cards|paynow|bizum|promptpay|dana|touch_n_go|tamara|qpay|ovo|momo|mercado_pago|nequi|nupay|picpay|thai_qr|blik|fpx|wero|p24|affirm_pay|rakuten_pay))*\\\
                            ]$"
                          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.\n\
                            * `chargebee_payments` - Chargebee Pay gateway\n* `adyen`\
                            \ - Adyen is a payment gateway.\n* `stripe` - Stripe is\
                            \ a payment gateway.\n* `wepay` - WePay is a payment gateway.\n\
                            * `braintree` - Braintree is a payment gateway.\n* `authorize_net`\
                            \ - Authorize.net is a payment gateway\n* `paypal_pro`\
                            \ - PayPal Pro Account is a payment gateway.\n* `pin`\
                            \ - Pin is a payment gateway\n* `eway` - eWAY Account\
                            \ is a payment gateway.\n* `eway_rapid` - eWAY Rapid is\
                            \ a payment gateway.\n* `worldpay` - WorldPay is a payment\
                            \ gateway\n* `balanced_payments` - Balanced is a payment\
                            \ gateway\n* `beanstream` - Bambora(formerly known as\
                            \ Beanstream) is a payment gateway.\n* `bluepay` - BluePay\
                            \ is a payment gateway.\n* `elavon` - Elavon Virtual Merchant\
                            \ is a payment solution.\n* `first_data_global` - First\
                            \ Data Global Gateway Virtual Terminal Account\n* `hdfc`\
                            \ - HDFC Account is a payment gateway.\n* `migs` - MasterCard\
                            \ Internet Gateway Service payment gateway.\n* `nmi` -\
                            \ NMI is a payment gateway.\n* `ogone` - Ingenico ePayments\
                            \ (formerly known as Ogone) is a payment gateway.\n* `paymill`\
                            \ - PAYMILL is a payment gateway.\n* `paypal_payflow_pro`\
                            \ - PayPal Payflow Pro is a payment gateway.\n* `sage_pay`\
                            \ - Sage Pay is a payment gateway.\n* `tco` - 2Checkout\
                            \ is a payment gateway.\n* `wirecard` - WireCard Account\
                            \ is a payment service provider.\n* `amazon_payments`\
                            \ - Amazon Payments is a payment service provider.\n*\
                            \ `paypal_express_checkout` - PayPal Express Checkout\
                            \ is a payment gateway.\n* `gocardless` - GoCardless is\
                            \ a payment service provider.\n* `orbital` - Chase Paymentech(Orbital)\
                            \ is a payment gateway.\n* `moneris_us` - Moneris USA\
                            \ is a payment gateway.\n* `moneris` - Moneris is a payment\
                            \ gateway.\n* `bluesnap` - BlueSnap is a payment gateway.\n\
                            * `cybersource` - CyberSource is a payment gateway.\n\
                            * `vantiv` - Vantiv is a payment gateway.\n* `checkout_com`\
                            \ - Checkout.com is a payment gateway.\n* `paypal` - PayPal\
                            \ Commerce is a payment gateway.\n* `ingenico_direct`\
                            \ - Worldline Online Payments is a payment gateway.\n\
                            * `exact` - Exact Payments is a payment gateway.\n* `mollie`\
                            \ - Mollie is a payment gateway.\n* `quickbooks` - Intuit\
                            \ QuickBooks Payments gateway\n* `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.\n\
                            * `global_payments` - Global Payments is a payment service\
                            \ provider.\n* `bank_of_america` - Bank of America Gateway\n\
                            * `ecentric` - Ecentric provides a seamless payment processing\
                            \ service in South Africa specializing on omnichannel\
                            \ capabilities.\n* `metrics_global` - Metrics global is\
                            \ a leading payment service provider providing unified\
                            \ payment services in the US.\n* `windcave` - Windcave\
                            \ provides an end to end payment processing solution in\
                            \ ANZ and other leading global markets.\n* `pay_com` -\
                            \ Pay.com provides payment services focused on simplicity\
                            \ and hassle-free operations for businesses of all sizes.\n\
                            * `ebanx` - EBANX is a payment gateway, enabling businesses\
                            \ to accept diverse local payment methods from various\
                            \ countries for increased market reach and conversion.\n\
                            * `dlocal` - Dlocal provides payment solutions for global\
                            \ commerce by accepting local payment methods.\n* `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.\n* `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.\n* `paystack`\
                            \ - Paystack is a payment gateway for businesses in Africa.\
                            \ It enables secure payment acceptance both online and\
                            \ offline.\n* `jp_morgan` - J.P. Morgan Mobility Payment\
                            \ Solutions is a payment gateway that enables you to securely\
                            \ accept and manage digital payments across different\
                            \ `payment_source_type`.\n* `deutsche_bank` - Deutsche\
                            \ Bank is the leading German bank with strong European\
                            \ roots and a global network.\n* `ezidebit` -\n  Ezidebit\
                            \ is a payment gateway integration based in Australia\
                            \ that supports automated direct debit, BPAY, and card\
                            \ payments for businesses.  \n  Ezidebit is in beta.\n\
                            * `twikey` - Twikey is a payment gateway that provides\
                            \ automated payment collection and mandate management\
                            \ solutions.\n* `tempus` - Tempus Technologies is a payment\
                            \ gateway and payments technology provider offering secure\
                            \ payment processing with end-to-end encryption (P2PE)\
                            \ and tokenization.\n* `moyasar` - Moyasar is a fully\
                            \ integrated online payment services that makes accepting\
                            \ payments simple and secure\n* `payway` - Payway is a\
                            \ payment gateway that enables secure card and payment\
                            \ acceptance.\n* `payu` - PayU is a payment gateway that\
                            \ enables secure card payment acceptance via PaymentsOS.\n\
                            * `not_applicable` - Indicates that payment gateway is\
                            \ not applicable for this resource.\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
                          - payu
                          - not_applicable
                          example: null
                        is_not:
                          type: string
                          description: "* `chargebee` - Chargebee test gateway.\n\
                            * `chargebee_payments` - Chargebee Pay gateway\n* `adyen`\
                            \ - Adyen is a payment gateway.\n* `stripe` - Stripe is\
                            \ a payment gateway.\n* `wepay` - WePay is a payment gateway.\n\
                            * `braintree` - Braintree is a payment gateway.\n* `authorize_net`\
                            \ - Authorize.net is a payment gateway\n* `paypal_pro`\
                            \ - PayPal Pro Account is a payment gateway.\n* `pin`\
                            \ - Pin is a payment gateway\n* `eway` - eWAY Account\
                            \ is a payment gateway.\n* `eway_rapid` - eWAY Rapid is\
                            \ a payment gateway.\n* `worldpay` - WorldPay is a payment\
                            \ gateway\n* `balanced_payments` - Balanced is a payment\
                            \ gateway\n* `beanstream` - Bambora(formerly known as\
                            \ Beanstream) is a payment gateway.\n* `bluepay` - BluePay\
                            \ is a payment gateway.\n* `elavon` - Elavon Virtual Merchant\
                            \ is a payment solution.\n* `first_data_global` - First\
                            \ Data Global Gateway Virtual Terminal Account\n* `hdfc`\
                            \ - HDFC Account is a payment gateway.\n* `migs` - MasterCard\
                            \ Internet Gateway Service payment gateway.\n* `nmi` -\
                            \ NMI is a payment gateway.\n* `ogone` - Ingenico ePayments\
                            \ (formerly known as Ogone) is a payment gateway.\n* `paymill`\
                            \ - PAYMILL is a payment gateway.\n* `paypal_payflow_pro`\
                            \ - PayPal Payflow Pro is a payment gateway.\n* `sage_pay`\
                            \ - Sage Pay is a payment gateway.\n* `tco` - 2Checkout\
                            \ is a payment gateway.\n* `wirecard` - WireCard Account\
                            \ is a payment service provider.\n* `amazon_payments`\
                            \ - Amazon Payments is a payment service provider.\n*\
                            \ `paypal_express_checkout` - PayPal Express Checkout\
                            \ is a payment gateway.\n* `gocardless` - GoCardless is\
                            \ a payment service provider.\n* `orbital` - Chase Paymentech(Orbital)\
                            \ is a payment gateway.\n* `moneris_us` - Moneris USA\
                            \ is a payment gateway.\n* `moneris` - Moneris is a payment\
                            \ gateway.\n* `bluesnap` - BlueSnap is a payment gateway.\n\
                            * `cybersource` - CyberSource is a payment gateway.\n\
                            * `vantiv` - Vantiv is a payment gateway.\n* `checkout_com`\
                            \ - Checkout.com is a payment gateway.\n* `paypal` - PayPal\
                            \ Commerce is a payment gateway.\n* `ingenico_direct`\
                            \ - Worldline Online Payments is a payment gateway.\n\
                            * `exact` - Exact Payments is a payment gateway.\n* `mollie`\
                            \ - Mollie is a payment gateway.\n* `quickbooks` - Intuit\
                            \ QuickBooks Payments gateway\n* `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.\n\
                            * `global_payments` - Global Payments is a payment service\
                            \ provider.\n* `bank_of_america` - Bank of America Gateway\n\
                            * `ecentric` - Ecentric provides a seamless payment processing\
                            \ service in South Africa specializing on omnichannel\
                            \ capabilities.\n* `metrics_global` - Metrics global is\
                            \ a leading payment service provider providing unified\
                            \ payment services in the US.\n* `windcave` - Windcave\
                            \ provides an end to end payment processing solution in\
                            \ ANZ and other leading global markets.\n* `pay_com` -\
                            \ Pay.com provides payment services focused on simplicity\
                            \ and hassle-free operations for businesses of all sizes.\n\
                            * `ebanx` - EBANX is a payment gateway, enabling businesses\
                            \ to accept diverse local payment methods from various\
                            \ countries for increased market reach and conversion.\n\
                            * `dlocal` - Dlocal provides payment solutions for global\
                            \ commerce by accepting local payment methods.\n* `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.\n* `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.\n* `paystack`\
                            \ - Paystack is a payment gateway for businesses in Africa.\
                            \ It enables secure payment acceptance both online and\
                            \ offline.\n* `jp_morgan` - J.P. Morgan Mobility Payment\
                            \ Solutions is a payment gateway that enables you to securely\
                            \ accept and manage digital payments across different\
                            \ `payment_source_type`.\n* `deutsche_bank` - Deutsche\
                            \ Bank is the leading German bank with strong European\
                            \ roots and a global network.\n* `ezidebit` -\n  Ezidebit\
                            \ is a payment gateway integration based in Australia\
                            \ that supports automated direct debit, BPAY, and card\
                            \ payments for businesses.  \n  Ezidebit is in beta.\n\
                            * `twikey` - Twikey is a payment gateway that provides\
                            \ automated payment collection and mandate management\
                            \ solutions.\n* `tempus` - Tempus Technologies is a payment\
                            \ gateway and payments technology provider offering secure\
                            \ payment processing with end-to-end encryption (P2PE)\
                            \ and tokenization.\n* `moyasar` - Moyasar is a fully\
                            \ integrated online payment services that makes accepting\
                            \ payments simple and secure\n* `payway` - Payway is a\
                            \ payment gateway that enables secure card and payment\
                            \ acceptance.\n* `payu` - PayU is a payment gateway that\
                            \ enables secure card payment acceptance via PaymentsOS.\n\
                            * `not_applicable` - Indicates that payment gateway is\
                            \ not applicable for this resource.\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
                          - payu
                          - not_applicable
                          example: null
                        in:
                          type: string
                          description: "* `chargebee` - Chargebee test gateway.\n\
                            * `chargebee_payments` - Chargebee Pay gateway\n* `adyen`\
                            \ - Adyen is a payment gateway.\n* `stripe` - Stripe is\
                            \ a payment gateway.\n* `wepay` - WePay is a payment gateway.\n\
                            * `braintree` - Braintree is a payment gateway.\n* `authorize_net`\
                            \ - Authorize.net is a payment gateway\n* `paypal_pro`\
                            \ - PayPal Pro Account is a payment gateway.\n* `pin`\
                            \ - Pin is a payment gateway\n* `eway` - eWAY Account\
                            \ is a payment gateway.\n* `eway_rapid` - eWAY Rapid is\
                            \ a payment gateway.\n* `worldpay` - WorldPay is a payment\
                            \ gateway\n* `balanced_payments` - Balanced is a payment\
                            \ gateway\n* `beanstream` - Bambora(formerly known as\
                            \ Beanstream) is a payment gateway.\n* `bluepay` - BluePay\
                            \ is a payment gateway.\n* `elavon` - Elavon Virtual Merchant\
                            \ is a payment solution.\n* `first_data_global` - First\
                            \ Data Global Gateway Virtual Terminal Account\n* `hdfc`\
                            \ - HDFC Account is a payment gateway.\n* `migs` - MasterCard\
                            \ Internet Gateway Service payment gateway.\n* `nmi` -\
                            \ NMI is a payment gateway.\n* `ogone` - Ingenico ePayments\
                            \ (formerly known as Ogone) is a payment gateway.\n* `paymill`\
                            \ - PAYMILL is a payment gateway.\n* `paypal_payflow_pro`\
                            \ - PayPal Payflow Pro is a payment gateway.\n* `sage_pay`\
                            \ - Sage Pay is a payment gateway.\n* `tco` - 2Checkout\
                            \ is a payment gateway.\n* `wirecard` - WireCard Account\
                            \ is a payment service provider.\n* `amazon_payments`\
                            \ - Amazon Payments is a payment service provider.\n*\
                            \ `paypal_express_checkout` - PayPal Express Checkout\
                            \ is a payment gateway.\n* `gocardless` - GoCardless is\
                            \ a payment service provider.\n* `orbital` - Chase Paymentech(Orbital)\
                            \ is a payment gateway.\n* `moneris_us` - Moneris USA\
                            \ is a payment gateway.\n* `moneris` - Moneris is a payment\
                            \ gateway.\n* `bluesnap` - BlueSnap is a payment gateway.\n\
                            * `cybersource` - CyberSource is a payment gateway.\n\
                            * `vantiv` - Vantiv is a payment gateway.\n* `checkout_com`\
                            \ - Checkout.com is a payment gateway.\n* `paypal` - PayPal\
                            \ Commerce is a payment gateway.\n* `ingenico_direct`\
                            \ - Worldline Online Payments is a payment gateway.\n\
                            * `exact` - Exact Payments is a payment gateway.\n* `mollie`\
                            \ - Mollie is a payment gateway.\n* `quickbooks` - Intuit\
                            \ QuickBooks Payments gateway\n* `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.\n\
                            * `global_payments` - Global Payments is a payment service\
                            \ provider.\n* `bank_of_america` - Bank of America Gateway\n\
                            * `ecentric` - Ecentric provides a seamless payment processing\
                            \ service in South Africa specializing on omnichannel\
                            \ capabilities.\n* `metrics_global` - Metrics global is\
                            \ a leading payment service provider providing unified\
                            \ payment services in the US.\n* `windcave` - Windcave\
                            \ provides an end to end payment processing solution in\
                            \ ANZ and other leading global markets.\n* `pay_com` -\
                            \ Pay.com provides payment services focused on simplicity\
                            \ and hassle-free operations for businesses of all sizes.\n\
                            * `ebanx` - EBANX is a payment gateway, enabling businesses\
                            \ to accept diverse local payment methods from various\
                            \ countries for increased market reach and conversion.\n\
                            * `dlocal` - Dlocal provides payment solutions for global\
                            \ commerce by accepting local payment methods.\n* `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.\n* `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.\n* `paystack`\
                            \ - Paystack is a payment gateway for businesses in Africa.\
                            \ It enables secure payment acceptance both online and\
                            \ offline.\n* `jp_morgan` - J.P. Morgan Mobility Payment\
                            \ Solutions is a payment gateway that enables you to securely\
                            \ accept and manage digital payments across different\
                            \ `payment_source_type`.\n* `deutsche_bank` - Deutsche\
                            \ Bank is the leading German bank with strong European\
                            \ roots and a global network.\n* `ezidebit` -\n  Ezidebit\
                            \ is a payment gateway integration based in Australia\
                            \ that supports automated direct debit, BPAY, and card\
                            \ payments for businesses.  \n  Ezidebit is in beta.\n\
                            * `twikey` - Twikey is a payment gateway that provides\
                            \ automated payment collection and mandate management\
                            \ solutions.\n* `tempus` - Tempus Technologies is a payment\
                            \ gateway and payments technology provider offering secure\
                            \ payment processing with end-to-end encryption (P2PE)\
                            \ and tokenization.\n* `moyasar` - Moyasar is a fully\
                            \ integrated online payment services that makes accepting\
                            \ payments simple and secure\n* `payway` - Payway is a\
                            \ payment gateway that enables secure card and payment\
                            \ acceptance.\n* `payu` - PayU is a payment gateway that\
                            \ enables secure card payment acceptance via PaymentsOS.\n\
                            * `not_applicable` - Indicates that payment gateway is\
                            \ not applicable for this resource.\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
                          - payu
                          - 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|payu|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|payu|not_applicable))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: "* `chargebee` - Chargebee test gateway.\n\
                            * `chargebee_payments` - Chargebee Pay gateway\n* `adyen`\
                            \ - Adyen is a payment gateway.\n* `stripe` - Stripe is\
                            \ a payment gateway.\n* `wepay` - WePay is a payment gateway.\n\
                            * `braintree` - Braintree is a payment gateway.\n* `authorize_net`\
                            \ - Authorize.net is a payment gateway\n* `paypal_pro`\
                            \ - PayPal Pro Account is a payment gateway.\n* `pin`\
                            \ - Pin is a payment gateway\n* `eway` - eWAY Account\
                            \ is a payment gateway.\n* `eway_rapid` - eWAY Rapid is\
                            \ a payment gateway.\n* `worldpay` - WorldPay is a payment\
                            \ gateway\n* `balanced_payments` - Balanced is a payment\
                            \ gateway\n* `beanstream` - Bambora(formerly known as\
                            \ Beanstream) is a payment gateway.\n* `bluepay` - BluePay\
                            \ is a payment gateway.\n* `elavon` - Elavon Virtual Merchant\
                            \ is a payment solution.\n* `first_data_global` - First\
                            \ Data Global Gateway Virtual Terminal Account\n* `hdfc`\
                            \ - HDFC Account is a payment gateway.\n* `migs` - MasterCard\
                            \ Internet Gateway Service payment gateway.\n* `nmi` -\
                            \ NMI is a payment gateway.\n* `ogone` - Ingenico ePayments\
                            \ (formerly known as Ogone) is a payment gateway.\n* `paymill`\
                            \ - PAYMILL is a payment gateway.\n* `paypal_payflow_pro`\
                            \ - PayPal Payflow Pro is a payment gateway.\n* `sage_pay`\
                            \ - Sage Pay is a payment gateway.\n* `tco` - 2Checkout\
                            \ is a payment gateway.\n* `wirecard` - WireCard Account\
                            \ is a payment service provider.\n* `amazon_payments`\
                            \ - Amazon Payments is a payment service provider.\n*\
                            \ `paypal_express_checkout` - PayPal Express Checkout\
                            \ is a payment gateway.\n* `gocardless` - GoCardless is\
                            \ a payment service provider.\n* `orbital` - Chase Paymentech(Orbital)\
                            \ is a payment gateway.\n* `moneris_us` - Moneris USA\
                            \ is a payment gateway.\n* `moneris` - Moneris is a payment\
                            \ gateway.\n* `bluesnap` - BlueSnap is a payment gateway.\n\
                            * `cybersource` - CyberSource is a payment gateway.\n\
                            * `vantiv` - Vantiv is a payment gateway.\n* `checkout_com`\
                            \ - Checkout.com is a payment gateway.\n* `paypal` - PayPal\
                            \ Commerce is a payment gateway.\n* `ingenico_direct`\
                            \ - Worldline Online Payments is a payment gateway.\n\
                            * `exact` - Exact Payments is a payment gateway.\n* `mollie`\
                            \ - Mollie is a payment gateway.\n* `quickbooks` - Intuit\
                            \ QuickBooks Payments gateway\n* `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.\n\
                            * `global_payments` - Global Payments is a payment service\
                            \ provider.\n* `bank_of_america` - Bank of America Gateway\n\
                            * `ecentric` - Ecentric provides a seamless payment processing\
                            \ service in South Africa specializing on omnichannel\
                            \ capabilities.\n* `metrics_global` - Metrics global is\
                            \ a leading payment service provider providing unified\
                            \ payment services in the US.\n* `windcave` - Windcave\
                            \ provides an end to end payment processing solution in\
                            \ ANZ and other leading global markets.\n* `pay_com` -\
                            \ Pay.com provides payment services focused on simplicity\
                            \ and hassle-free operations for businesses of all sizes.\n\
                            * `ebanx` - EBANX is a payment gateway, enabling businesses\
                            \ to accept diverse local payment methods from various\
                            \ countries for increased market reach and conversion.\n\
                            * `dlocal` - Dlocal provides payment solutions for global\
                            \ commerce by accepting local payment methods.\n* `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.\n* `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.\n* `paystack`\
                            \ - Paystack is a payment gateway for businesses in Africa.\
                            \ It enables secure payment acceptance both online and\
                            \ offline.\n* `jp_morgan` - J.P. Morgan Mobility Payment\
                            \ Solutions is a payment gateway that enables you to securely\
                            \ accept and manage digital payments across different\
                            \ `payment_source_type`.\n* `deutsche_bank` - Deutsche\
                            \ Bank is the leading German bank with strong European\
                            \ roots and a global network.\n* `ezidebit` -\n  Ezidebit\
                            \ is a payment gateway integration based in Australia\
                            \ that supports automated direct debit, BPAY, and card\
                            \ payments for businesses.  \n  Ezidebit is in beta.\n\
                            * `twikey` - Twikey is a payment gateway that provides\
                            \ automated payment collection and mandate management\
                            \ solutions.\n* `tempus` - Tempus Technologies is a payment\
                            \ gateway and payments technology provider offering secure\
                            \ payment processing with end-to-end encryption (P2PE)\
                            \ and tokenization.\n* `moyasar` - Moyasar is a fully\
                            \ integrated online payment services that makes accepting\
                            \ payments simple and secure\n* `payway` - Payway is a\
                            \ payment gateway that enables secure card and payment\
                            \ acceptance.\n* `payu` - PayU is a payment gateway that\
                            \ enables secure card payment acceptance via PaymentsOS.\n\
                            * `not_applicable` - Indicates that payment gateway is\
                            \ not applicable for this resource.\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
                          - payu
                          - 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|payu|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|payu|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: |
                        The reference number for this transaction. For example, the check number when [payment_method](/docs/api/transactions/transaction-object#payment_method)
                        = `check`
                        .
                      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 [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources).
                            * `payment` - The transaction represents capture of [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources).
                            * `refund` - The transaction represents a refund of [amount](transactions#transaction_amount) to the customer's [payment_source](payment_sources).
                            * `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 [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources).
                            * `payment` - The transaction represents capture of [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources).
                            * `refund` - The transaction represents a refund of [amount](transactions#transaction_amount) to the customer's [payment_source](payment_sources).
                            * `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 [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources).
                            * `payment` - The transaction represents capture of [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources).
                            * `refund` - The transaction represents a refund of [amount](transactions#transaction_amount) to the customer's [payment_source](payment_sources).
                            * `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 [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources).
                            * `payment` - The transaction represents capture of [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources).
                            * `refund` - The transaction represents a refund of [amount](transactions#transaction_amount) to the customer's [payment_source](payment_sources).
                            * `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: |
                        To filter based on `updated_at`.
                        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 `sort_by`
                        input parameter as `updated_at`
                        for a faster response.
                      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: |
                      Resource object representing export
                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/ramps:
    post:
      tags:
      - exports
      summary: Export Subscription Ramps
      description: "Starts an export job for [subscription ramps](/docs/api/ramps)\
        \ data. The exported zip file contains CSV files with ramp-related data. \
        \ \n\n### Best practice\n\nFor a full data export, use filters to export in\
        \ batches, as suggested in the samples below.\n"
      operationId: export_subscription_ramps
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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 - Provides the full set of data for the subscription ramps in multiple `.csv` files.
                    * import_friendly_data - Provides a `.csv` file whose columns match the [`ramp`](/docs/api/ramps/ramp-object) schema. This file format can be readily imported through the UI by using [Bulk Operations](https://www.chargebee.com/docs/bulk-operations.html).
                  enum:
                  - data
                  - import_friendly_data
                  example: null
                ramp:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for ramp
                  properties:
                    status:
                      type: object
                      deprecated: false
                      description: |
                        The execution status of the ramp. Use this filter to export ramps in a specific status, such as `scheduled`
                        , `succeeded`
                        , `failed`
                        , or `draft`.
                      example: SCHEDULED
                      properties:
                        in:
                          type: string
                          description: "* `scheduled` - Status of the subscription\
                            \ schedule on creation. \n* `succeeded` - The execution\
                            \ status of the schedule if success. \n* `failed` - The\
                            \ execution status of the schedule if failed. \n* `draft`\
                            \ - Status of the subscription schedule considering as\
                            \ draft"
                          enum:
                          - scheduled
                          - succeeded
                          - failed
                          - draft
                          pattern: "^\\[(scheduled|succeeded|failed|draft)(,(scheduled|succeeded|failed|draft))*\\\
                            ]$"
                          example: null
                        is:
                          type: string
                          description: "* `scheduled` - Status of the subscription\
                            \ schedule on creation. \n* `succeeded` - The execution\
                            \ status of the schedule if success. \n* `failed` - The\
                            \ execution status of the schedule if failed. \n* `draft`\
                            \ - Status of the subscription schedule considering as\
                            \ draft"
                          enum:
                          - scheduled
                          - succeeded
                          - failed
                          - draft
                          example: null
                    subscription_id:
                      type: object
                      deprecated: false
                      description: |
                        The ID of the subscription for which the ramp was created. Use this filter to export ramps that belong to specific subscriptions.
                      example: 8gsnbYfsMLds
                      properties:
                        in:
                          type: string
                          pattern: "^\\[(.*)(,.*)*\\]$"
                          example: null
                        is:
                          type: string
                          minLength: 1
                          example: null
                    effective_from:
                      type: object
                      deprecated: false
                      description: |
                        To filter based on `effective_from`
                        , the time when the changes defined in the ramp are applied to the subscription by executing the ramp.
                      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. It is advisable when using this filter, to pass the `sort_by`
                        input parameter as `updated_at`
                        for a faster response. [Learn more](/docs/api/exports) about the best practice before performing full export.
                      example: "1435052328"
                      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:
              ramp:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  export:
                    $ref: "#/components/schemas/Export"
                    description: |
                      Resource object representing export
                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/differential_prices:
    post:
      tags:
      - exports
      summary: Export differential price
      description: |
        This API triggers export of differential price data. The exported zip file contains CSV files with differential price-related data.
      operationId: export_differential_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                item_id:
                  type: object
                  deprecated: false
                  description: |
                    optional, string filter

                    Item Id of Addon / Charge item price for which differential pricing is applied to.
                    **Supported operators :**
                    is, is_not, starts_with, in, not_in

                    **Example →**
                    *item_id\[is\] = "day-pass"*
                  example: day-pass
                  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
                differential_price:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for differential_price
                  properties:
                    item_price_id:
                      type: object
                      deprecated: false
                      description: |
                        The id of the item price (`addon`
                        or `charge`
                        ) whose price should change according to the plan-item it is applied to.
                      example: day-pass-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
                    id:
                      type: object
                      deprecated: false
                      description: |
                        A unique and immutable id for the differential price. It is auto-generated when the differential price is created.
                      example: defcc4f1-f21f-47f4-8019-beddb9beab5f
                      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
                    parent_item_id:
                      type: object
                      deprecated: false
                      description: |
                        The id of the plan-item, in relation to which, the differential pricing for the addon or charge is defined. For example, this would be the id of the *Standard*
                        or *Enterprise*
                        plans-items mentioned in the [examples above](/docs/api/differential_prices)
                        .
                      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
                  example: null
              example: null
            encoding:
              differential_price:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  export:
                    $ref: "#/components/schemas/Export"
                    description: |
                      Resource object representing export
                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/item_families:
    post:
      tags:
      - exports
      summary: Export item families
      description: |
        This API triggers export of item family data. The exported zip file contains CSV files with item family-related data.
      operationId: export_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: 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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                business_entity_id:
                  type: object
                  deprecated: false
                  description: |
                    optional, string filter

                    The unique ID of the
                    [business entity](/docs/api/business_entities)
                    of this `item_family`.
                    [Learn more](/docs/api/using_business_entity_filters_in_product_catalog_list_apis)
                    about all the scenarios before using this filter.

                    **Supported operators :**
                    is, is_present

                    **Example →**
                    *business_entity_id\[is_present\] = "true"*
                  example: business_entity_id
                  properties:
                    is:
                      type: string
                      minLength: 1
                      example: null
                    is_present:
                      type: string
                      format: boolean
                      enum:
                      - "true"
                      - "false"
                      example: null
                include_site_level_resources:
                  type: object
                  deprecated: false
                  description: |
                    optional, boolean filter

                    Default value is `true` . To exclude site-level resources in [specific cases](/docs/api/using_business_entity_filters_in_product_catalog_list_apis), set this parameter to `false`.
                    Possible values are : *true, false*

                    **Supported operators :**
                    is

                    **Example →**
                    *include_site_level_resources\[is\] = "null"*
                  properties:
                    is:
                      type: string
                      format: boolean
                      enum:
                      - "true"
                      - "false"
                      example: null
                  example: null
                item_family:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_family
                  properties:
                    id:
                      type: object
                      deprecated: false
                      description: |
                        The identifier for the item family. It is unique and immutable.
                      example: family-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
                        in:
                          type: string
                          pattern: "^\\[(.*)(,.*)*\\]$"
                          example: null
                        not_in:
                          type: string
                          pattern: "^\\[(.*)(,.*)*\\]$"
                          example: null
                    name:
                      type: object
                      deprecated: false
                      description: |
                        A unique display name for the item family. This is visible only in Chargebee and not to customers.
                      example: family-name
                      properties:
                        is:
                          type: string
                          minLength: 1
                          example: null
                        is_not:
                          type: string
                          minLength: 1
                          example: null
                        starts_with:
                          type: string
                          minLength: 1
                          example: null
                    updated_at:
                      type: object
                      deprecated: false
                      description: |
                        When the item family was last 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
                  example: null
              example: null
            encoding:
              item_family:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  export:
                    $ref: "#/components/schemas/Export"
                    description: |
                      Resource object representing export
                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:
      tags:
      - exports
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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.\n* `posted`\
                            \ - Indicates the payment is not yet collected and will\
                            \ be in this state till the due date to indicate the due\
                            \ period\n* `payment_due` - Indicates the payment is not\
                            \ yet collected and is being retried as per retry settings.\n\
                            * `not_paid` - Indicates the payment is not made and all\
                            \ attempts to collect is failed.\n* `voided` - Indicates\
                            \ a voided invoice.\n* `pending` -\n  The [invoice](/docs/api/invoices?prod_cat_ver=2#invoice_status)\
                            \ is yet to be closed (sent for payment collection). An\
                            \ invoice is generated with this `status` when it has\
                            \ line items that belong to items that are `metered` or\
                            \ when the `subscription.create_pending_invoices`attribute\
                            \ is set to `true`.  \n  The [invoice](/docs/api/invoices?prod_cat_ver=1#invoice_status)\
                            \ is yet to be closed (sent for payment collection). All\
                            \ invoices are generated with this `status` when [Metered\
                            \ Billing](https://www.chargebee.com/docs/1.0/metered_billing.html)\
                            \ is enabled for the site.\n"
                          enum:
                          - paid
                          - posted
                          - payment_due
                          - not_paid
                          - voided
                          - pending
                          example: null
                        is_not:
                          type: string
                          description: "* `paid` - Indicates a paid invoice.\n* `posted`\
                            \ - Indicates the payment is not yet collected and will\
                            \ be in this state till the due date to indicate the due\
                            \ period\n* `payment_due` - Indicates the payment is not\
                            \ yet collected and is being retried as per retry settings.\n\
                            * `not_paid` - Indicates the payment is not made and all\
                            \ attempts to collect is failed.\n* `voided` - Indicates\
                            \ a voided invoice.\n* `pending` -\n  The [invoice](/docs/api/invoices?prod_cat_ver=2#invoice_status)\
                            \ is yet to be closed (sent for payment collection). An\
                            \ invoice is generated with this `status` when it has\
                            \ line items that belong to items that are `metered` or\
                            \ when the `subscription.create_pending_invoices`attribute\
                            \ is set to `true`.  \n  The [invoice](/docs/api/invoices?prod_cat_ver=1#invoice_status)\
                            \ is yet to be closed (sent for payment collection). All\
                            \ invoices are generated with this `status` when [Metered\
                            \ Billing](https://www.chargebee.com/docs/1.0/metered_billing.html)\
                            \ is enabled for the site.\n"
                          enum:
                          - paid
                          - posted
                          - payment_due
                          - not_paid
                          - voided
                          - pending
                          example: null
                        in:
                          type: string
                          description: "* `paid` - Indicates a paid invoice.\n* `posted`\
                            \ - Indicates the payment is not yet collected and will\
                            \ be in this state till the due date to indicate the due\
                            \ period\n* `payment_due` - Indicates the payment is not\
                            \ yet collected and is being retried as per retry settings.\n\
                            * `not_paid` - Indicates the payment is not made and all\
                            \ attempts to collect is failed.\n* `voided` - Indicates\
                            \ a voided invoice.\n* `pending` -\n  The [invoice](/docs/api/invoices?prod_cat_ver=2#invoice_status)\
                            \ is yet to be closed (sent for payment collection). An\
                            \ invoice is generated with this `status` when it has\
                            \ line items that belong to items that are `metered` or\
                            \ when the `subscription.create_pending_invoices`attribute\
                            \ is set to `true`.  \n  The [invoice](/docs/api/invoices?prod_cat_ver=1#invoice_status)\
                            \ is yet to be closed (sent for payment collection). All\
                            \ invoices are generated with this `status` when [Metered\
                            \ Billing](https://www.chargebee.com/docs/1.0/metered_billing.html)\
                            \ is enabled for the site.\n"
                          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.\n* `posted`\
                            \ - Indicates the payment is not yet collected and will\
                            \ be in this state till the due date to indicate the due\
                            \ period\n* `payment_due` - Indicates the payment is not\
                            \ yet collected and is being retried as per retry settings.\n\
                            * `not_paid` - Indicates the payment is not made and all\
                            \ attempts to collect is failed.\n* `voided` - Indicates\
                            \ a voided invoice.\n* `pending` -\n  The [invoice](/docs/api/invoices?prod_cat_ver=2#invoice_status)\
                            \ is yet to be closed (sent for payment collection). An\
                            \ invoice is generated with this `status` when it has\
                            \ line items that belong to items that are `metered` or\
                            \ when the `subscription.create_pending_invoices`attribute\
                            \ is set to `true`.  \n  The [invoice](/docs/api/invoices?prod_cat_ver=1#invoice_status)\
                            \ is yet to be closed (sent for payment collection). All\
                            \ invoices are generated with this `status` when [Metered\
                            \ Billing](https://www.chargebee.com/docs/1.0/metered_billing.html)\
                            \ is enabled for the site.\n"
                          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: |
                        Payments collected successfully for the invoice. This is the sum of [linked_payments[]](/docs/api/invoices/invoice-object#linked_payments)`.txn_amount`
                        for all `linked_payments[]`
                        that have `txn_status`
                        as `success`.
                      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: |
                        The unpaid amount that is due on the invoice. This is calculated as: [total](/docs/api/invoices/invoice-object#total)

                        * [amount_paid](/docs/api/invoices/invoice-object#amount_paid)
                        * sum of [applied_credits](/docs/api/invoices/invoice-object#applied_credits)`.applied_amount`
                        * sum of [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)`.cn_total`
                        * sum of [linked_taxes_withheld](/docs/api/invoices/invoice-object#linked_taxes_withheld)`.amount`.
                      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: |
                        To filter based on `updated_at`.
                        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 `sort_by`
                        input parameter as `updated_at`
                        for a faster response. [Learn more](/docs/api/exports) about the best practice before performing full export.
                      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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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: |
                      Resource object representing export
                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:
      tags:
      - exports
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - 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: |
                      Resource object representing export
                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/price_variants:
    post:
      tags:
      - exports
      summary: Export price variants
      description: |
        This API triggers export of price variant data. The exported zip file contains CSV files with price variant-related data.
      operationId: export_price_variants
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                business_entity_id:
                  type: object
                  deprecated: false
                  description: |
                    optional, string filter

                    The unique ID of the
                    [business entity](/docs/api/business_entities)
                    of this `price_variant`.
                    [Learn more](/docs/api/using_business_entity_filters_in_product_catalog_list_apis)
                    about all the scenarios before using this filter.

                    **Supported operators :**
                    is, is_present

                    **Example →**
                    *business_entity_id\[is_present\] = "true"*
                  example: business_entity_id
                  properties:
                    is:
                      type: string
                      minLength: 1
                      example: null
                    is_present:
                      type: string
                      format: boolean
                      enum:
                      - "true"
                      - "false"
                      example: null
                include_site_level_resources:
                  type: object
                  deprecated: false
                  description: |
                    optional, boolean filter

                    Default value is `true` . To exclude site-level resources in [specific cases](), set this parameter to `false`.
                    Possible values are : *true, false*

                    **Supported operators :**
                    is

                    **Example →**
                    *include_site_level_resources\[is\] = "null"*
                  properties:
                    is:
                      type: string
                      format: boolean
                      enum:
                      - "true"
                      - "false"
                      example: null
                  example: null
                price_variant:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for price_variant
                  properties:
                    id:
                      type: object
                      deprecated: false
                      description: |
                        Filter variant based on their [id](/docs/api/exports)
                        .
                      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:
                      type: object
                      deprecated: false
                      description: |
                        Filter variant based on their `name`
                        s.
                      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: |
                        Filter variant based on their `status`
                        .
                      example: active
                      properties:
                        is:
                          type: string
                          description: |-
                            * `active` - Active
                            * `archived` - Archived
                          enum:
                          - active
                          - archived
                          example: null
                        is_not:
                          type: string
                          description: |-
                            * `active` - Active
                            * `archived` - Archived
                          enum:
                          - active
                          - archived
                          example: null
                        in:
                          type: string
                          description: |-
                            * `active` - Active
                            * `archived` - Archived
                          enum:
                          - active
                          - archived
                          pattern: "^\\[(active|archived)(,(active|archived))*\\]$"
                          example: null
                        not_in:
                          type: string
                          description: |-
                            * `active` - Active
                            * `archived` - Archived
                          enum:
                          - active
                          - archived
                          pattern: "^\\[(active|archived)(,(active|archived))*\\]$"
                          example: null
                    updated_at:
                      type: object
                      deprecated: false
                      description: |
                        Filter product based on their `updated time`
                        .
                      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
                    created_at:
                      type: object
                      deprecated: false
                      description: |
                        Filter product based on their `created time`
                        .
                      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:
              price_variant:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  export:
                    $ref: "#/components/schemas/Export"
                    description: |
                      Resource object representing export
                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/items:
    post:
      tags:
      - exports
      summary: Export items
      description: |
        This API triggers export of item data. The exported zip file contains CSV files with item-related data.
      operationId: export_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                business_entity_id:
                  type: object
                  deprecated: false
                  description: |
                    optional, string filter

                    The unique ID of the
                    [business entity](/docs/api/business_entities)
                    of this `item`.
                    [Learn more](/docs/api/using_business_entity_filters_in_product_catalog_list_apis)
                    about all the scenarios before using this filter.

                    **Supported operators :**
                    is, is_present

                    **Example →**
                    *business_entity_id\[is_present\] = "true"*
                  example: business_entity_id
                  properties:
                    is:
                      type: string
                      minLength: 1
                      example: null
                    is_present:
                      type: string
                      format: boolean
                      enum:
                      - "true"
                      - "false"
                      example: null
                include_site_level_resources:
                  type: object
                  deprecated: false
                  description: |
                    optional, boolean filter

                    Default value is `true` . To exclude site-level resources in [specific cases](), set this parameter to `false`.
                    Possible values are : *true, false*

                    **Supported operators :**
                    is

                    **Example →**
                    *include_site_level_resources\[is\] = "null"*
                  properties:
                    is:
                      type: string
                      format: boolean
                      enum:
                      - "true"
                      - "false"
                      example: null
                  example: null
                item:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item
                  properties:
                    id:
                      type: object
                      deprecated: false
                      description: |
                        Filter items based on item id.
                      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
                    item_family_id:
                      type: object
                      deprecated: false
                      description: |
                        Filter items based on `item_family_id`
                        .
                      example: acme
                      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
                    type:
                      type: object
                      deprecated: false
                      description: |
                        Filter items based on item `type`
                        .
                      example: plan
                      properties:
                        is:
                          type: string
                          description: |
                            * `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.
                            * `addon` - A recurring component that can be added to a subscription in addition to its plan.
                            * `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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.
                          enum:
                          - plan
                          - addon
                          - charge
                          example: null
                        is_not:
                          type: string
                          description: |
                            * `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.
                            * `addon` - A recurring component that can be added to a subscription in addition to its plan.
                            * `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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.
                          enum:
                          - plan
                          - addon
                          - charge
                          example: null
                        in:
                          type: string
                          description: |
                            * `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.
                            * `addon` - A recurring component that can be added to a subscription in addition to its plan.
                            * `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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.
                          enum:
                          - plan
                          - addon
                          - charge
                          pattern: "^\\[(plan|addon|charge)(,(plan|addon|charge))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            * `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.
                            * `addon` - A recurring component that can be added to a subscription in addition to its plan.
                            * `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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.
                          enum:
                          - plan
                          - addon
                          - charge
                          pattern: "^\\[(plan|addon|charge)(,(plan|addon|charge))*\\\
                            ]$"
                          example: null
                    name:
                      type: object
                      deprecated: false
                      description: |
                        Filter items based on item `name`
                        .
                      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
                    item_applicability:
                      type: object
                      deprecated: false
                      description: |
                        Filter items based on `item_applicability`
                        .
                      example: all
                      properties:
                        is:
                          type: string
                          description: |
                            * `all` - all addon-items and charge-items are applicable to this plan-item.
                            * `restricted` - only the addon-items or charge-items provided in `applicable_items` can be applied to this plan-item.
                          enum:
                          - all
                          - restricted
                          example: null
                        is_not:
                          type: string
                          description: |
                            * `all` - all addon-items and charge-items are applicable to this plan-item.
                            * `restricted` - only the addon-items or charge-items provided in `applicable_items` can be applied to this plan-item.
                          enum:
                          - all
                          - restricted
                          example: null
                        in:
                          type: string
                          description: |
                            * `all` - all addon-items and charge-items are applicable to this plan-item.
                            * `restricted` - only the addon-items or charge-items provided in `applicable_items` can be applied to this plan-item.
                          enum:
                          - all
                          - restricted
                          pattern: "^\\[(all|restricted)(,(all|restricted))*\\]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            * `all` - all addon-items and charge-items are applicable to this plan-item.
                            * `restricted` - only the addon-items or charge-items provided in `applicable_items` can be applied to this plan-item.
                          enum:
                          - all
                          - restricted
                          pattern: "^\\[(all|restricted)(,(all|restricted))*\\]$"
                          example: null
                    status:
                      type: object
                      deprecated: false
                      description: |
                        Filter items based on item `status`
                        .
                      example: active
                      properties:
                        is:
                          type: string
                          description: |
                            * `active` - The item can be used to create new item prices.
                            * `archived` - The item is no longer active and no new item prices can be created
                            * `deleted` - Indicates that the item has been [deleted](./items?prod_cat_ver=2#delete_an_item). The `id` and `name` can be reused. Deleted items can be retrieved using [List items](./items?prod_cat_ver=2#list_items).
                          enum:
                          - active
                          - archived
                          - deleted
                          example: null
                        is_not:
                          type: string
                          description: |
                            * `active` - The item can be used to create new item prices.
                            * `archived` - The item is no longer active and no new item prices can be created
                            * `deleted` - Indicates that the item has been [deleted](./items?prod_cat_ver=2#delete_an_item). The `id` and `name` can be reused. Deleted items can be retrieved using [List items](./items?prod_cat_ver=2#list_items).
                          enum:
                          - active
                          - archived
                          - deleted
                          example: null
                        in:
                          type: string
                          description: |
                            * `active` - The item can be used to create new item prices.
                            * `archived` - The item is no longer active and no new item prices can be created
                            * `deleted` - Indicates that the item has been [deleted](./items?prod_cat_ver=2#delete_an_item). The `id` and `name` can be reused. Deleted items can be retrieved using [List items](./items?prod_cat_ver=2#list_items).
                          enum:
                          - active
                          - archived
                          - deleted
                          pattern: "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            * `active` - The item can be used to create new item prices.
                            * `archived` - The item is no longer active and no new item prices can be created
                            * `deleted` - Indicates that the item has been [deleted](./items?prod_cat_ver=2#delete_an_item). The `id` and `name` can be reused. Deleted items can be retrieved using [List items](./items?prod_cat_ver=2#list_items).
                          enum:
                          - active
                          - archived
                          - deleted
                          pattern: "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\\
                            ]$"
                          example: null
                    is_giftable:
                      type: object
                      deprecated: false
                      description: |
                        Specifies if gift subscriptions can be created for this item.
                      example: "true"
                      properties:
                        is:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    updated_at:
                      type: object
                      deprecated: false
                      description: |
                        Filter items based on when the items were last 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
                    enabled_for_checkout:
                      type: object
                      deprecated: false
                      description: |
                        Allow the plan to subscribed to via Checkout. Applies only for plan-items.
                        **Note:**
                        Only the in-app layout of Checkout is supported.
                      properties:
                        is:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                      example: null
                    enabled_in_portal:
                      type: object
                      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)
                        .
                      properties:
                        is:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                      example: null
                    metered:
                      type: object
                      deprecated: false
                      description: |
                        Specifies whether the item undergoes metered billing. When `true`, the quantity is calculated from [usage records](/docs/api/usages). When `false`, the `quantity` is as determined while adding an item price to the subscription. Applicable only for items of `type` `plan` or `addon` and when [Metered Billing](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing) is enabled. The value of this attribute cannot be changed.
                      example: "true"
                      properties:
                        is:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          example: null
                    usage_calculation:
                      type: object
                      deprecated: false
                      description: |
                        How the quantity is calculated from usage data for the item prices belonging to this item. Only applicable when the item is `metered`.
                        This value overrides the one [set at the site level](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing)
                        .
                      example: SUM_OF_USAGES
                      properties:
                        is:
                          type: string
                          description: |
                            * `sum_of_usages` - the net quantity is the sum of the `quantity` of all usages for the current term.
                            * `last_usage` - from among the usage records for the [item price](/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id) with `usage_date` within the relevant billing period, the `quantity` of the usage record with the most recent `usage_date` is taken as the net quantity consumed.
                            * `max_usage` - from among the usage records for the [item price](/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id) with `usage_date` within the relevant billing period, the `quantity` of the usage record with the maximum value is taken as the net quantity consumed.
                          enum:
                          - sum_of_usages
                          - last_usage
                          - max_usage
                          example: null
                        is_not:
                          type: string
                          description: |
                            * `sum_of_usages` - the net quantity is the sum of the `quantity` of all usages for the current term.
                            * `last_usage` - from among the usage records for the [item price](/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id) with `usage_date` within the relevant billing period, the `quantity` of the usage record with the most recent `usage_date` is taken as the net quantity consumed.
                            * `max_usage` - from among the usage records for the [item price](/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id) with `usage_date` within the relevant billing period, the `quantity` of the usage record with the maximum value is taken as the net quantity consumed.
                          enum:
                          - sum_of_usages
                          - last_usage
                          - max_usage
                          example: null
                        in:
                          type: string
                          description: |
                            * `sum_of_usages` - the net quantity is the sum of the `quantity` of all usages for the current term.
                            * `last_usage` - from among the usage records for the [item price](/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id) with `usage_date` within the relevant billing period, the `quantity` of the usage record with the most recent `usage_date` is taken as the net quantity consumed.
                            * `max_usage` - from among the usage records for the [item price](/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id) with `usage_date` within the relevant billing period, the `quantity` of the usage record with the maximum value is taken as the net quantity consumed.
                          enum:
                          - sum_of_usages
                          - last_usage
                          - max_usage
                          pattern: "^\\[(sum_of_usages|last_usage|max_usage)(,(sum_of_usages|last_usage|max_usage))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            * `sum_of_usages` - the net quantity is the sum of the `quantity` of all usages for the current term.
                            * `last_usage` - from among the usage records for the [item price](/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id) with `usage_date` within the relevant billing period, the `quantity` of the usage record with the most recent `usage_date` is taken as the net quantity consumed.
                            * `max_usage` - from among the usage records for the [item price](/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id) with `usage_date` within the relevant billing period, the `quantity` of the usage record with the maximum value is taken as the net quantity consumed.
                          enum:
                          - sum_of_usages
                          - last_usage
                          - max_usage
                          pattern: "^\\[(sum_of_usages|last_usage|max_usage)(,(sum_of_usages|last_usage|max_usage))*\\\
                            ]$"
                          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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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:
              item:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  export:
                    $ref: "#/components/schemas/Export"
                    description: |
                      Resource object representing export
                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:
      tags:
      - exports
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
                item_id:
                  type: object
                  deprecated: false
                  description: |
                    optional, string filter

                    The plan item code.
                    **Supported operators :**
                    is, is_not, starts_with, in, not_in

                    **Example →**
                    *item_id\[is\] = "silver"*
                  example: silver
                  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
                item_price_id:
                  type: object
                  deprecated: false
                  description: |
                    optional, string filter

                    The plan item price code.
                    **Supported operators :**
                    is, is_not, starts_with, in, not_in

                    **Example →**
                    *item_price_id\[is\] = "silver-USD-monthly"*
                  example: silver-USD-monthly
                  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 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 unique ID of the
                    [business entity](/docs/api/getting-started)
                    of this subscription. This is always the same as the
                    [business entity](/docs/api/subscriptions/subscription-object#customer_id)
                    of the customer.

                    **Supported operators :**
                    is, is_not, starts_with

                    **Example →**
                    *business_entity_id\[is_not\] = "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.\n* `posted`\
                            \ - Indicates the payment is not yet collected and will\
                            \ be in this state till the due date to indicate the due\
                            \ period\n* `payment_due` - Indicates the payment is not\
                            \ yet collected and is being retried as per retry settings.\n\
                            * `not_paid` - Indicates the payment is not made and all\
                            \ attempts to collect is failed.\n* `voided` - Indicates\
                            \ a voided invoice.\n* `pending` -\n  The [invoice](/docs/api/invoices?prod_cat_ver=2#invoice_status)\
                            \ is yet to be closed (sent for payment collection). An\
                            \ invoice is generated with this `status` when it has\
                            \ line items that belong to items that are `metered` or\
                            \ when the `subscription.create_pending_invoices`attribute\
                            \ is set to `true`.  \n  The [invoice](/docs/api/invoices?prod_cat_ver=1#invoice_status)\
                            \ is yet to be closed (sent for payment collection). All\
                            \ invoices are generated with this `status` when [Metered\
                            \ Billing](https://www.chargebee.com/docs/1.0/metered_billing.html)\
                            \ is enabled for the site.\n"
                          enum:
                          - paid
                          - posted
                          - payment_due
                          - not_paid
                          - voided
                          - pending
                          example: null
                        is_not:
                          type: string
                          description: "* `paid` - Indicates a paid invoice.\n* `posted`\
                            \ - Indicates the payment is not yet collected and will\
                            \ be in this state till the due date to indicate the due\
                            \ period\n* `payment_due` - Indicates the payment is not\
                            \ yet collected and is being retried as per retry settings.\n\
                            * `not_paid` - Indicates the payment is not made and all\
                            \ attempts to collect is failed.\n* `voided` - Indicates\
                            \ a voided invoice.\n* `pending` -\n  The [invoice](/docs/api/invoices?prod_cat_ver=2#invoice_status)\
                            \ is yet to be closed (sent for payment collection). An\
                            \ invoice is generated with this `status` when it has\
                            \ line items that belong to items that are `metered` or\
                            \ when the `subscription.create_pending_invoices`attribute\
                            \ is set to `true`.  \n  The [invoice](/docs/api/invoices?prod_cat_ver=1#invoice_status)\
                            \ is yet to be closed (sent for payment collection). All\
                            \ invoices are generated with this `status` when [Metered\
                            \ Billing](https://www.chargebee.com/docs/1.0/metered_billing.html)\
                            \ is enabled for the site.\n"
                          enum:
                          - paid
                          - posted
                          - payment_due
                          - not_paid
                          - voided
                          - pending
                          example: null
                        in:
                          type: string
                          description: "* `paid` - Indicates a paid invoice.\n* `posted`\
                            \ - Indicates the payment is not yet collected and will\
                            \ be in this state till the due date to indicate the due\
                            \ period\n* `payment_due` - Indicates the payment is not\
                            \ yet collected and is being retried as per retry settings.\n\
                            * `not_paid` - Indicates the payment is not made and all\
                            \ attempts to collect is failed.\n* `voided` - Indicates\
                            \ a voided invoice.\n* `pending` -\n  The [invoice](/docs/api/invoices?prod_cat_ver=2#invoice_status)\
                            \ is yet to be closed (sent for payment collection). An\
                            \ invoice is generated with this `status` when it has\
                            \ line items that belong to items that are `metered` or\
                            \ when the `subscription.create_pending_invoices`attribute\
                            \ is set to `true`.  \n  The [invoice](/docs/api/invoices?prod_cat_ver=1#invoice_status)\
                            \ is yet to be closed (sent for payment collection). All\
                            \ invoices are generated with this `status` when [Metered\
                            \ Billing](https://www.chargebee.com/docs/1.0/metered_billing.html)\
                            \ is enabled for the site.\n"
                          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.\n* `posted`\
                            \ - Indicates the payment is not yet collected and will\
                            \ be in this state till the due date to indicate the due\
                            \ period\n* `payment_due` - Indicates the payment is not\
                            \ yet collected and is being retried as per retry settings.\n\
                            * `not_paid` - Indicates the payment is not made and all\
                            \ attempts to collect is failed.\n* `voided` - Indicates\
                            \ a voided invoice.\n* `pending` -\n  The [invoice](/docs/api/invoices?prod_cat_ver=2#invoice_status)\
                            \ is yet to be closed (sent for payment collection). An\
                            \ invoice is generated with this `status` when it has\
                            \ line items that belong to items that are `metered` or\
                            \ when the `subscription.create_pending_invoices`attribute\
                            \ is set to `true`.  \n  The [invoice](/docs/api/invoices?prod_cat_ver=1#invoice_status)\
                            \ is yet to be closed (sent for payment collection). All\
                            \ invoices are generated with this `status` when [Metered\
                            \ Billing](https://www.chargebee.com/docs/1.0/metered_billing.html)\
                            \ is enabled for the site.\n"
                          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: |
                        Payments collected successfully for the invoice. This is the sum of [linked_payments[]](/docs/api/invoices/invoice-object#linked_payments)`.txn_amount`
                        for all `linked_payments[]`
                        that have `txn_status`
                        as `success`.
                      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: |
                        The unpaid amount that is due on the invoice. This is calculated as: [total](/docs/api/invoices/invoice-object#total)

                        * [amount_paid](/docs/api/invoices/invoice-object#amount_paid)
                        * sum of [applied_credits](/docs/api/invoices/invoice-object#applied_credits)`.applied_amount`
                        * sum of [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)`.cn_total`
                        * sum of [linked_taxes_withheld](/docs/api/invoices/invoice-object#linked_taxes_withheld)`.amount`.
                      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: |
                        To filter based on `updated_at`.
                        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 `sort_by`
                        input parameter as `updated_at`
                        for a faster response.
                      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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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
                    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: |
                        Time at which the subscription `status`
                        last changed to
                        `active`.
                        For example, this value is updated when an `in_trial`
                        or
                        `cancelled`
                        subscription activates.
                      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: |
                        The date/time at which the next billing for the subscription happens. This is usually right after `current_term_end`
                        unless multiple subscription terms were invoiced in advance using the `terms_to_charge`
                        parameter.
                      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: |
                        If `true`
                        , there are subscription changes scheduled on next renewal.
                      example: "true"
                      properties:
                        is:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          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. It is advisable when using this filter, to pass the `sort_by`
                        input parameter as `updated_at`
                        for a faster response.
                      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: |
                        Set to `false`
                        to override for this subscription, the [site-level setting](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing)
                        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 [customer level](/docs/api/customers/customer-object#auto_close_invoices)
                        .
                      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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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. Possible values are : taxable, exempt, zero_rated.
                      example: taxable
                      properties:
                        is:
                          type: string
                          description: |
                            * `taxable` - Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html). 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` -
                              * Customer is exempted from tax. When using Chargebee's native [Taxes](https://www.chargebee.com/docs/tax.html) feature or when using the [TaxJar integration](https://www.chargebee.com/docs/taxjar.html), no other action is needed.
                              * However, when using our [Avalara integration](https://www.chargebee.com/docs/avalara.html), optionally, specify `entity_code` or `exempt_number` attributes if you use Chargebee's [AvaTax for Sales](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption) or specify `exemption_details` attribute if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. Tax may still be applied by Avalara for certain values of `entity_code`/`exempt_number`/`exemption_details` based on the state/region/province of the taxable address.
                            * `zero_rated` - With [Chargebee Taxes](https://www.chargebee.com/docs/tax.html), otherwise taxable line items for the customer are taxed at 0%. These line items have `is_taxed` set to `true`, the tax rate and tax amount set to `0`, and `tax_exempt_reason` set to `zero_rated`. Unlike `exempt`, this option follows the taxable tax path at a zero rate.
                          enum:
                          - taxable
                          - exempt
                          - zero_rated
                          example: null
                        is_not:
                          type: string
                          description: |
                            * `taxable` - Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html). 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` -
                              * Customer is exempted from tax. When using Chargebee's native [Taxes](https://www.chargebee.com/docs/tax.html) feature or when using the [TaxJar integration](https://www.chargebee.com/docs/taxjar.html), no other action is needed.
                              * However, when using our [Avalara integration](https://www.chargebee.com/docs/avalara.html), optionally, specify `entity_code` or `exempt_number` attributes if you use Chargebee's [AvaTax for Sales](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption) or specify `exemption_details` attribute if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. Tax may still be applied by Avalara for certain values of `entity_code`/`exempt_number`/`exemption_details` based on the state/region/province of the taxable address.
                            * `zero_rated` - With [Chargebee Taxes](https://www.chargebee.com/docs/tax.html), otherwise taxable line items for the customer are taxed at 0%. These line items have `is_taxed` set to `true`, the tax rate and tax amount set to `0`, and `tax_exempt_reason` set to `zero_rated`. Unlike `exempt`, this option follows the taxable tax path at a zero rate.
                          enum:
                          - taxable
                          - exempt
                          - zero_rated
                          example: null
                        in:
                          type: string
                          description: |
                            * `taxable` - Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html). 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` -
                              * Customer is exempted from tax. When using Chargebee's native [Taxes](https://www.chargebee.com/docs/tax.html) feature or when using the [TaxJar integration](https://www.chargebee.com/docs/taxjar.html), no other action is needed.
                              * However, when using our [Avalara integration](https://www.chargebee.com/docs/avalara.html), optionally, specify `entity_code` or `exempt_number` attributes if you use Chargebee's [AvaTax for Sales](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption) or specify `exemption_details` attribute if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. Tax may still be applied by Avalara for certain values of `entity_code`/`exempt_number`/`exemption_details` based on the state/region/province of the taxable address.
                            * `zero_rated` - With [Chargebee Taxes](https://www.chargebee.com/docs/tax.html), otherwise taxable line items for the customer are taxed at 0%. These line items have `is_taxed` set to `true`, the tax rate and tax amount set to `0`, and `tax_exempt_reason` set to `zero_rated`. Unlike `exempt`, this option follows the taxable tax path at a zero rate.
                          enum:
                          - taxable
                          - exempt
                          - zero_rated
                          pattern: "^\\[(taxable|exempt|zero_rated)(,(taxable|exempt|zero_rated))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            * `taxable` - Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html). 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` -
                              * Customer is exempted from tax. When using Chargebee's native [Taxes](https://www.chargebee.com/docs/tax.html) feature or when using the [TaxJar integration](https://www.chargebee.com/docs/taxjar.html), no other action is needed.
                              * However, when using our [Avalara integration](https://www.chargebee.com/docs/avalara.html), optionally, specify `entity_code` or `exempt_number` attributes if you use Chargebee's [AvaTax for Sales](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption) or specify `exemption_details` attribute if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. Tax may still be applied by Avalara for certain values of `entity_code`/`exempt_number`/`exemption_details` based on the state/region/province of the taxable address.
                            * `zero_rated` - With [Chargebee Taxes](https://www.chargebee.com/docs/tax.html), otherwise taxable line items for the customer are taxed at 0%. These line items have `is_taxed` set to `true`, the tax rate and tax amount set to `0`, and `tax_exempt_reason` set to `zero_rated`. Unlike `exempt`, this option follows the taxable tax path at a zero rate.
                          enum:
                          - taxable
                          - exempt
                          - zero_rated
                          pattern: "^\\[(taxable|exempt|zero_rated)(,(taxable|exempt|zero_rated))*\\\
                            ]$"
                          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: |
                        To filter based on `updated_at`.
                        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 `sort_by`
                        input parameter as `updated_at`
                        for a faster response.
                      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/billing/2.0/usage-based-billing/metered_billing#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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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: |
                      Resource object representing export
                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:
      tags:
      - exports
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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\] = "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
                item_id:
                  type: object
                  deprecated: false
                  description: |
                    optional, string filter

                    The plan item code.
                    **Supported operators :**
                    is, is_not, starts_with, in, not_in

                    **Example →**
                    *item_id\[is\] = "silver"*
                  example: silver
                  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
                item_price_id:
                  type: object
                  deprecated: false
                  description: |
                    optional, string filter

                    The plan item price code.
                    **Supported operators :**
                    is, is_not, starts_with, in, not_in

                    **Example →**
                    *item_price_id\[is\] = "silver-USD-monthly"*
                  example: silver-USD-monthly
                  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 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 unique ID of the
                    [business entity](/docs/api/getting-started)
                    of this subscription. This is always the same as the
                    [business entity](/docs/api/subscriptions/subscription-object#customer_id)
                    of the customer.

                    **Supported operators :**
                    is, is_not, starts_with

                    **Example →**
                    *business_entity_id\[is_not\] = "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.\n* `posted`\
                            \ - Indicates the payment is not yet collected and will\
                            \ be in this state till the due date to indicate the due\
                            \ period\n* `payment_due` - Indicates the payment is not\
                            \ yet collected and is being retried as per retry settings.\n\
                            * `not_paid` - Indicates the payment is not made and all\
                            \ attempts to collect is failed.\n* `voided` - Indicates\
                            \ a voided invoice.\n* `pending` -\n  The [invoice](/docs/api/invoices?prod_cat_ver=2#invoice_status)\
                            \ is yet to be closed (sent for payment collection). An\
                            \ invoice is generated with this `status` when it has\
                            \ line items that belong to items that are `metered` or\
                            \ when the `subscription.create_pending_invoices`attribute\
                            \ is set to `true`.  \n  The [invoice](/docs/api/invoices?prod_cat_ver=1#invoice_status)\
                            \ is yet to be closed (sent for payment collection). All\
                            \ invoices are generated with this `status` when [Metered\
                            \ Billing](https://www.chargebee.com/docs/1.0/metered_billing.html)\
                            \ is enabled for the site.\n"
                          enum:
                          - paid
                          - posted
                          - payment_due
                          - not_paid
                          - voided
                          - pending
                          example: null
                        is_not:
                          type: string
                          description: "* `paid` - Indicates a paid invoice.\n* `posted`\
                            \ - Indicates the payment is not yet collected and will\
                            \ be in this state till the due date to indicate the due\
                            \ period\n* `payment_due` - Indicates the payment is not\
                            \ yet collected and is being retried as per retry settings.\n\
                            * `not_paid` - Indicates the payment is not made and all\
                            \ attempts to collect is failed.\n* `voided` - Indicates\
                            \ a voided invoice.\n* `pending` -\n  The [invoice](/docs/api/invoices?prod_cat_ver=2#invoice_status)\
                            \ is yet to be closed (sent for payment collection). An\
                            \ invoice is generated with this `status` when it has\
                            \ line items that belong to items that are `metered` or\
                            \ when the `subscription.create_pending_invoices`attribute\
                            \ is set to `true`.  \n  The [invoice](/docs/api/invoices?prod_cat_ver=1#invoice_status)\
                            \ is yet to be closed (sent for payment collection). All\
                            \ invoices are generated with this `status` when [Metered\
                            \ Billing](https://www.chargebee.com/docs/1.0/metered_billing.html)\
                            \ is enabled for the site.\n"
                          enum:
                          - paid
                          - posted
                          - payment_due
                          - not_paid
                          - voided
                          - pending
                          example: null
                        in:
                          type: string
                          description: "* `paid` - Indicates a paid invoice.\n* `posted`\
                            \ - Indicates the payment is not yet collected and will\
                            \ be in this state till the due date to indicate the due\
                            \ period\n* `payment_due` - Indicates the payment is not\
                            \ yet collected and is being retried as per retry settings.\n\
                            * `not_paid` - Indicates the payment is not made and all\
                            \ attempts to collect is failed.\n* `voided` - Indicates\
                            \ a voided invoice.\n* `pending` -\n  The [invoice](/docs/api/invoices?prod_cat_ver=2#invoice_status)\
                            \ is yet to be closed (sent for payment collection). An\
                            \ invoice is generated with this `status` when it has\
                            \ line items that belong to items that are `metered` or\
                            \ when the `subscription.create_pending_invoices`attribute\
                            \ is set to `true`.  \n  The [invoice](/docs/api/invoices?prod_cat_ver=1#invoice_status)\
                            \ is yet to be closed (sent for payment collection). All\
                            \ invoices are generated with this `status` when [Metered\
                            \ Billing](https://www.chargebee.com/docs/1.0/metered_billing.html)\
                            \ is enabled for the site.\n"
                          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.\n* `posted`\
                            \ - Indicates the payment is not yet collected and will\
                            \ be in this state till the due date to indicate the due\
                            \ period\n* `payment_due` - Indicates the payment is not\
                            \ yet collected and is being retried as per retry settings.\n\
                            * `not_paid` - Indicates the payment is not made and all\
                            \ attempts to collect is failed.\n* `voided` - Indicates\
                            \ a voided invoice.\n* `pending` -\n  The [invoice](/docs/api/invoices?prod_cat_ver=2#invoice_status)\
                            \ is yet to be closed (sent for payment collection). An\
                            \ invoice is generated with this `status` when it has\
                            \ line items that belong to items that are `metered` or\
                            \ when the `subscription.create_pending_invoices`attribute\
                            \ is set to `true`.  \n  The [invoice](/docs/api/invoices?prod_cat_ver=1#invoice_status)\
                            \ is yet to be closed (sent for payment collection). All\
                            \ invoices are generated with this `status` when [Metered\
                            \ Billing](https://www.chargebee.com/docs/1.0/metered_billing.html)\
                            \ is enabled for the site.\n"
                          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: |
                        Payments collected successfully for the invoice. This is the sum of [linked_payments[]](/docs/api/invoices/invoice-object#linked_payments)`.txn_amount`
                        for all `linked_payments[]`
                        that have `txn_status`
                        as `success`.
                      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: |
                        The unpaid amount that is due on the invoice. This is calculated as: [total](/docs/api/invoices/invoice-object#total)

                        * [amount_paid](/docs/api/invoices/invoice-object#amount_paid)
                        * sum of [applied_credits](/docs/api/invoices/invoice-object#applied_credits)`.applied_amount`
                        * sum of [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)`.cn_total`
                        * sum of [linked_taxes_withheld](/docs/api/invoices/invoice-object#linked_taxes_withheld)`.amount`.
                      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: |
                        To filter based on `updated_at`.
                        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 `sort_by`
                        input parameter as `updated_at`
                        for a faster response.
                      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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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
                    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: |
                        Time at which the subscription `status`
                        last changed to
                        `active`.
                        For example, this value is updated when an `in_trial`
                        or
                        `cancelled`
                        subscription activates.
                      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: |
                        The date/time at which the next billing for the subscription happens. This is usually right after `current_term_end`
                        unless multiple subscription terms were invoiced in advance using the `terms_to_charge`
                        parameter.
                      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: |
                        If `true`
                        , there are subscription changes scheduled on next renewal.
                      example: "true"
                      properties:
                        is:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          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. It is advisable when using this filter, to pass the `sort_by`
                        input parameter as `updated_at`
                        for a faster response.
                      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: |
                        Set to `false`
                        to override for this subscription, the [site-level setting](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing)
                        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 [customer level](/docs/api/customers/customer-object#auto_close_invoices)
                        .
                      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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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. Possible values are : taxable, exempt, zero_rated.
                      example: taxable
                      properties:
                        is:
                          type: string
                          description: |
                            * `taxable` - Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html). 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` -
                              * Customer is exempted from tax. When using Chargebee's native [Taxes](https://www.chargebee.com/docs/tax.html) feature or when using the [TaxJar integration](https://www.chargebee.com/docs/taxjar.html), no other action is needed.
                              * However, when using our [Avalara integration](https://www.chargebee.com/docs/avalara.html), optionally, specify `entity_code` or `exempt_number` attributes if you use Chargebee's [AvaTax for Sales](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption) or specify `exemption_details` attribute if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. Tax may still be applied by Avalara for certain values of `entity_code`/`exempt_number`/`exemption_details` based on the state/region/province of the taxable address.
                            * `zero_rated` - With [Chargebee Taxes](https://www.chargebee.com/docs/tax.html), otherwise taxable line items for the customer are taxed at 0%. These line items have `is_taxed` set to `true`, the tax rate and tax amount set to `0`, and `tax_exempt_reason` set to `zero_rated`. Unlike `exempt`, this option follows the taxable tax path at a zero rate.
                          enum:
                          - taxable
                          - exempt
                          - zero_rated
                          example: null
                        is_not:
                          type: string
                          description: |
                            * `taxable` - Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html). 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` -
                              * Customer is exempted from tax. When using Chargebee's native [Taxes](https://www.chargebee.com/docs/tax.html) feature or when using the [TaxJar integration](https://www.chargebee.com/docs/taxjar.html), no other action is needed.
                              * However, when using our [Avalara integration](https://www.chargebee.com/docs/avalara.html), optionally, specify `entity_code` or `exempt_number` attributes if you use Chargebee's [AvaTax for Sales](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption) or specify `exemption_details` attribute if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. Tax may still be applied by Avalara for certain values of `entity_code`/`exempt_number`/`exemption_details` based on the state/region/province of the taxable address.
                            * `zero_rated` - With [Chargebee Taxes](https://www.chargebee.com/docs/tax.html), otherwise taxable line items for the customer are taxed at 0%. These line items have `is_taxed` set to `true`, the tax rate and tax amount set to `0`, and `tax_exempt_reason` set to `zero_rated`. Unlike `exempt`, this option follows the taxable tax path at a zero rate.
                          enum:
                          - taxable
                          - exempt
                          - zero_rated
                          example: null
                        in:
                          type: string
                          description: |
                            * `taxable` - Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html). 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` -
                              * Customer is exempted from tax. When using Chargebee's native [Taxes](https://www.chargebee.com/docs/tax.html) feature or when using the [TaxJar integration](https://www.chargebee.com/docs/taxjar.html), no other action is needed.
                              * However, when using our [Avalara integration](https://www.chargebee.com/docs/avalara.html), optionally, specify `entity_code` or `exempt_number` attributes if you use Chargebee's [AvaTax for Sales](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption) or specify `exemption_details` attribute if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. Tax may still be applied by Avalara for certain values of `entity_code`/`exempt_number`/`exemption_details` based on the state/region/province of the taxable address.
                            * `zero_rated` - With [Chargebee Taxes](https://www.chargebee.com/docs/tax.html), otherwise taxable line items for the customer are taxed at 0%. These line items have `is_taxed` set to `true`, the tax rate and tax amount set to `0`, and `tax_exempt_reason` set to `zero_rated`. Unlike `exempt`, this option follows the taxable tax path at a zero rate.
                          enum:
                          - taxable
                          - exempt
                          - zero_rated
                          pattern: "^\\[(taxable|exempt|zero_rated)(,(taxable|exempt|zero_rated))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            * `taxable` - Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html). 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` -
                              * Customer is exempted from tax. When using Chargebee's native [Taxes](https://www.chargebee.com/docs/tax.html) feature or when using the [TaxJar integration](https://www.chargebee.com/docs/taxjar.html), no other action is needed.
                              * However, when using our [Avalara integration](https://www.chargebee.com/docs/avalara.html), optionally, specify `entity_code` or `exempt_number` attributes if you use Chargebee's [AvaTax for Sales](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption) or specify `exemption_details` attribute if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. Tax may still be applied by Avalara for certain values of `entity_code`/`exempt_number`/`exemption_details` based on the state/region/province of the taxable address.
                            * `zero_rated` - With [Chargebee Taxes](https://www.chargebee.com/docs/tax.html), otherwise taxable line items for the customer are taxed at 0%. These line items have `is_taxed` set to `true`, the tax rate and tax amount set to `0`, and `tax_exempt_reason` set to `zero_rated`. Unlike `exempt`, this option follows the taxable tax path at a zero rate.
                          enum:
                          - taxable
                          - exempt
                          - zero_rated
                          pattern: "^\\[(taxable|exempt|zero_rated)(,(taxable|exempt|zero_rated))*\\\
                            ]$"
                          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: |
                        To filter based on `updated_at`.
                        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 `sort_by`
                        input parameter as `updated_at`
                        for a faster response.
                      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/billing/2.0/usage-based-billing/metered_billing#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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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: |
                      Resource object representing export
                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:
      tags:
      - exports
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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/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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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: |
                      Resource object representing export
                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:
      tags:
      - exports
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    optional, string filter

                    List of itemPrice ids for which these coupons are applicable.

                    **Supported operators :**
                    in, is

                    **Example →**
                    *applicable_item_price_ids\[in\] = "day-pass-USD"*
                  example: day-pass-USD
                  properties:
                    in:
                      type: string
                      pattern: "^\\[(.*)(,.*)*\\]$"
                      example: null
                    is:
                      type: string
                      minLength: 1
                      example: null
                coupon:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for coupon
                  properties:
                    id:
                      type: object
                      deprecated: false
                      description: "Used to uniquely identify the coupon in your website/application\
                        \ and to integrate with Chargebee.  \n**Note:**\n\nWhen the\
                        \ coupon ID contains a special character; for example: `#`,\
                        \ the API returns an error. Make sure that you [encode](https://www.urlencoder.org/)\
                        \ the coupon ID in the path parameter before making an API\
                        \ call.\n"
                      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: "The display name used in web interface for identifying\
                        \ the coupon.  \n**Note:**\n\nWhen the name of the coupon\
                        \ set contains a special character; for example: `#`, the\
                        \ API returns an error. Make sure that you [encode](https://www.urlencoder.org/)\
                        \ the name of the coupon set in the path parameter before\
                        \ making an API call.\n"
                      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 **once**. It is removed after that from the subscription.
                            * `forever` - The coupon is attached to the subscription and applied on the invoices until explicitly removed.
                            * `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 `period` and `period_unit`.
                          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 **once**. It is removed after that from the subscription.
                            * `forever` - The coupon is attached to the subscription and applied on the invoices until explicitly removed.
                            * `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 `period` and `period_unit`.
                          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 **once**. It is removed after that from the subscription.
                            * `forever` - The coupon is attached to the subscription and applied on the invoices until explicitly removed.
                            * `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 `period` and `period_unit`.
                          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 **once**. It is removed after that from the subscription.
                            * `forever` - The coupon is attached to the subscription and applied on the invoices until explicitly removed.
                            * `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 `period` and `period_unit`.
                          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 [max_redemptions](/docs/api/coupons?#coupon_max_redemptions) or [valid_till](/docs/api/coupons?#coupon_valid_till) 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.
                            * `future` - The coupon is scheduled to start at a future date and cannot be applied to a subscription. From the valid_from date, the status changes to active.
                          enum:
                          - active
                          - expired
                          - archived
                          - deleted
                          - future
                          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 [max_redemptions](/docs/api/coupons?#coupon_max_redemptions) or [valid_till](/docs/api/coupons?#coupon_valid_till) 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.
                            * `future` - The coupon is scheduled to start at a future date and cannot be applied to a subscription. From the valid_from date, the status changes to active.
                          enum:
                          - active
                          - expired
                          - archived
                          - deleted
                          - future
                          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 [max_redemptions](/docs/api/coupons?#coupon_max_redemptions) or [valid_till](/docs/api/coupons?#coupon_valid_till) 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.
                            * `future` - The coupon is scheduled to start at a future date and cannot be applied to a subscription. From the valid_from date, the status changes to active.
                          enum:
                          - active
                          - expired
                          - archived
                          - deleted
                          - future
                          pattern: "^\\[(active|expired|archived|deleted|future)(,(active|expired|archived|deleted|future))*\\\
                            ]$"
                          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 [max_redemptions](/docs/api/coupons?#coupon_max_redemptions) or [valid_till](/docs/api/coupons?#coupon_valid_till) 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.
                            * `future` - The coupon is scheduled to start at a future date and cannot be applied to a subscription. From the valid_from date, the status changes to active.
                          enum:
                          - active
                          - expired
                          - archived
                          - deleted
                          - future
                          pattern: "^\\[(active|expired|archived|deleted|future)(,(active|expired|archived|deleted|future))*\\\
                            ]$"
                          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 `sub_total`.\n* `specified_items_total`\
                            \ - **(Deprecated)** Discount will be applied to the total\
                            \ of plan and addon items specified.\n* `each_specified_item`\
                            \ -\n  The coupon is applied to the `invoice.line_item.amount`\
                            \ that corresponds to the item price specified by `item_price_id`.\
                            \  \n  The coupon is applied to the `invoice.line_item.amount`\
                            \ that corresponds to the plan or addon specified by `plan_ids`\
                            \ and `addon_ids`.\n* `each_unit_of_specified_items` -\
                            \ **(Deprecated)** Discount will be applied to each unit\
                            \ of plan and addon items specified.\n"
                          enum:
                          - invoice_amount
                          - each_specified_item
                          example: null
                        is_not:
                          type: string
                          description: "* `invoice_amount` - The coupon is applied\
                            \ to the invoice `sub_total`.\n* `specified_items_total`\
                            \ - **(Deprecated)** Discount will be applied to the total\
                            \ of plan and addon items specified.\n* `each_specified_item`\
                            \ -\n  The coupon is applied to the `invoice.line_item.amount`\
                            \ that corresponds to the item price specified by `item_price_id`.\
                            \  \n  The coupon is applied to the `invoice.line_item.amount`\
                            \ that corresponds to the plan or addon specified by `plan_ids`\
                            \ and `addon_ids`.\n* `each_unit_of_specified_items` -\
                            \ **(Deprecated)** Discount will be applied to each unit\
                            \ of plan and addon items specified.\n"
                          enum:
                          - invoice_amount
                          - each_specified_item
                          example: null
                        in:
                          type: string
                          description: "* `invoice_amount` - The coupon is applied\
                            \ to the invoice `sub_total`.\n* `specified_items_total`\
                            \ - **(Deprecated)** Discount will be applied to the total\
                            \ of plan and addon items specified.\n* `each_specified_item`\
                            \ -\n  The coupon is applied to the `invoice.line_item.amount`\
                            \ that corresponds to the item price specified by `item_price_id`.\
                            \  \n  The coupon is applied to the `invoice.line_item.amount`\
                            \ that corresponds to the plan or addon specified by `plan_ids`\
                            \ and `addon_ids`.\n* `each_unit_of_specified_items` -\
                            \ **(Deprecated)** Discount will be applied to each unit\
                            \ of plan and addon items specified.\n"
                          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 `sub_total`.\n* `specified_items_total`\
                            \ - **(Deprecated)** Discount will be applied to the total\
                            \ of plan and addon items specified.\n* `each_specified_item`\
                            \ -\n  The coupon is applied to the `invoice.line_item.amount`\
                            \ that corresponds to the item price specified by `item_price_id`.\
                            \  \n  The coupon is applied to the `invoice.line_item.amount`\
                            \ that corresponds to the plan or addon specified by `plan_ids`\
                            \ and `addon_ids`.\n* `each_unit_of_specified_items` -\
                            \ **(Deprecated)** Discount will be applied to each unit\
                            \ of plan and addon items specified.\n"
                          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: |
                      Resource object representing export
                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:
      tags:
      - exports
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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\[is\] = "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: |
                      Resource object representing export
                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/item_prices:
    post:
      tags:
      - exports
      summary: Export item prices
      description: |
        This API triggers export of item price data. The exported zip file contains CSV files with item price-related data.
      operationId: export_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: 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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                item_family_id:
                  type: object
                  deprecated: false
                  description: |
                    optional, string filter

                    Filter item prices based on `item_family_id`
                    .
                    **Supported operators :**
                    is, is_not, starts_with, in, not_in

                    **Example →**
                    *item_family_id\[is\] = "Acme"*
                  example: Acme
                  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
                item_type:
                  type: object
                  deprecated: false
                  description: |
                    optional, enumerated string filter

                    Filter item prices based on `item_type`.
                    Possible values are : plan, addon, charge.

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

                    **Example →**
                    *item_type\[is_not\] = "plan"*
                  example: plan
                  properties:
                    is:
                      type: string
                      description: |
                        * `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.
                        * `addon` - A recurring component that can be added to a subscription in addition to its plan.
                        * `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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.
                      enum:
                      - plan
                      - addon
                      - charge
                      example: null
                    is_not:
                      type: string
                      description: |
                        * `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.
                        * `addon` - A recurring component that can be added to a subscription in addition to its plan.
                        * `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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.
                      enum:
                      - plan
                      - addon
                      - charge
                      example: null
                    in:
                      type: string
                      description: |
                        * `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.
                        * `addon` - A recurring component that can be added to a subscription in addition to its plan.
                        * `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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.
                      enum:
                      - plan
                      - addon
                      - charge
                      pattern: "^\\[(plan|addon|charge)(,(plan|addon|charge))*\\]$"
                      example: null
                    not_in:
                      type: string
                      description: |
                        * `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.
                        * `addon` - A recurring component that can be added to a subscription in addition to its plan.
                        * `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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.
                      enum:
                      - plan
                      - addon
                      - charge
                      pattern: "^\\[(plan|addon|charge)(,(plan|addon|charge))*\\]$"
                      example: null
                currency_code:
                  type: object
                  deprecated: false
                  description: |
                    optional, string filter

                    Filter item prices based on their `currency_code`
                    .
                    **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
                business_entity_id:
                  type: object
                  deprecated: false
                  description: |
                    optional, string filter

                    The unique ID of the
                    [business entity](/docs/api/business_entities)
                    of this `item_price`.
                    [Learn more](/docs/api/using_business_entity_filters_in_product_catalog_list_apis)
                    about all the scenarios before using this filter.

                    **Supported operators :**
                    is, is_present

                    **Example →**
                    *business_entity_id\[is_present\] = "true"*
                  example: business_entity_id
                  properties:
                    is:
                      type: string
                      minLength: 1
                      example: null
                    is_present:
                      type: string
                      format: boolean
                      enum:
                      - "true"
                      - "false"
                      example: null
                include_site_level_resources:
                  type: object
                  deprecated: false
                  description: |
                    optional, boolean filter

                    Default value is `true` . To exclude site-level resources in [specific cases](), set this parameter to `false`.
                    Possible values are : *true, false*

                    **Supported operators :**
                    is

                    **Example →**
                    *include_site_level_resources\[is\] = "null"*
                  properties:
                    is:
                      type: string
                      format: boolean
                      enum:
                      - "true"
                      - "false"
                      example: null
                  example: null
                item_price:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_price
                  properties:
                    id:
                      type: object
                      deprecated: false
                      description: |
                        Filter item prices based on their [id](/docs/api/exports)
                        .
                      example: basic_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:
                      type: object
                      deprecated: false
                      description: |
                        Filter item prices based on their `name`
                        s.
                      example: basic 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
                    pricing_model:
                      type: object
                      deprecated: false
                      description: |
                        Filter item prices based on their `pricing_model`
                        .
                      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
                    item_id:
                      type: object
                      deprecated: false
                      description: |
                        Filter item prices based on their `item_id`
                        .
                      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
                    price_variant_id:
                      type: object
                      deprecated: false
                      description: |
                        Filter item prices based on their [price_variant_id](/docs/api/price_variants/price_variant-object#id)
                        .
                      example: tamilNadu-India
                      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
                    trial_period:
                      type: object
                      deprecated: false
                      description: |
                        Filter item prices based on their `trial_period`
                        .
                      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
                    trial_period_unit:
                      type: object
                      deprecated: false
                      description: |
                        Filter item prices based on their `trial_period_unit`
                        .
                      example: day
                      properties:
                        is:
                          type: string
                          description: |-
                            * `day` - A period of 24 hours.
                            * `month` - A period of 1 calendar month.
                          enum:
                          - day
                          - month
                          example: null
                        is_not:
                          type: string
                          description: |-
                            * `day` - A period of 24 hours.
                            * `month` - A period of 1 calendar month.
                          enum:
                          - day
                          - month
                          example: null
                        in:
                          type: string
                          description: |-
                            * `day` - A period of 24 hours.
                            * `month` - A period of 1 calendar month.
                          enum:
                          - day
                          - month
                          pattern: "^\\[(day|month)(,(day|month))*\\]$"
                          example: null
                        not_in:
                          type: string
                          description: |-
                            * `day` - A period of 24 hours.
                            * `month` - A period of 1 calendar month.
                          enum:
                          - day
                          - month
                          pattern: "^\\[(day|month)(,(day|month))*\\]$"
                          example: null
                    status:
                      type: object
                      deprecated: false
                      description: |
                        Filter item prices based on their `status`
                        .
                      example: active
                      properties:
                        is:
                          type: string
                          description: |
                            * `active` - The item price can be used in subscriptions.
                            * `archived` - 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.
                            * `deleted` - Indicates that the item price has been deleted. The `id` and `name` can be reused.
                          enum:
                          - active
                          - archived
                          - deleted
                          example: null
                        is_not:
                          type: string
                          description: |
                            * `active` - The item price can be used in subscriptions.
                            * `archived` - 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.
                            * `deleted` - Indicates that the item price has been deleted. The `id` and `name` can be reused.
                          enum:
                          - active
                          - archived
                          - deleted
                          example: null
                        in:
                          type: string
                          description: |
                            * `active` - The item price can be used in subscriptions.
                            * `archived` - 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.
                            * `deleted` - Indicates that the item price has been deleted. The `id` and `name` can be reused.
                          enum:
                          - active
                          - archived
                          - deleted
                          pattern: "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |
                            * `active` - The item price can be used in subscriptions.
                            * `archived` - 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.
                            * `deleted` - Indicates that the item price has been deleted. The `id` and `name` can be reused.
                          enum:
                          - active
                          - archived
                          - deleted
                          pattern: "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\\
                            ]$"
                          example: null
                    updated_at:
                      type: object
                      deprecated: false
                      description: |
                        Filter item prices based on their `updated_at`
                        .
                      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
                    period_unit:
                      type: object
                      deprecated: false
                      description: |
                        Filter item prices based on their `period_unit`
                        .
                      example: month
                      properties:
                        is:
                          type: string
                          description: |-
                            * `day` - A period of 24 hours.
                            * `week` - A period of 7 days.
                            * `month` - A period of 1 calendar month.
                            * `year` - A period of 1 calendar year.
                          enum:
                          - day
                          - week
                          - month
                          - year
                          example: null
                        is_not:
                          type: string
                          description: |-
                            * `day` - A period of 24 hours.
                            * `week` - A period of 7 days.
                            * `month` - A period of 1 calendar month.
                            * `year` - A period of 1 calendar year.
                          enum:
                          - day
                          - week
                          - month
                          - year
                          example: null
                        in:
                          type: string
                          description: |-
                            * `day` - A period of 24 hours.
                            * `week` - A period of 7 days.
                            * `month` - A period of 1 calendar month.
                            * `year` - A period of 1 calendar year.
                          enum:
                          - day
                          - week
                          - month
                          - year
                          pattern: "^\\[(day|week|month|year)(,(day|week|month|year))*\\\
                            ]$"
                          example: null
                        not_in:
                          type: string
                          description: |-
                            * `day` - A period of 24 hours.
                            * `week` - A period of 7 days.
                            * `month` - A period of 1 calendar month.
                            * `year` - A period of 1 calendar year.
                          enum:
                          - day
                          - week
                          - month
                          - year
                          pattern: "^\\[(day|week|month|year)(,(day|week|month|year))*\\\
                            ]$"
                          example: null
                    period:
                      type: object
                      deprecated: false
                      description: |
                        Filter item prices based on their `period`
                        .
                      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
                    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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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:
              item_price:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  export:
                    $ref: "#/components/schemas/Export"
                    description: |
                      Resource object representing export
                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:
      tags:
      - exports
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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 - Provides the full set of data for the subscriptions in multiple `.csv` files.
                    * import_friendly_data - Provides a `.csv` file whose columns match the [`subscription`](/docs/api/subscriptions/subscription-object) schema. This file format can be readily imported through the UI by using [Bulk Operations](https://www.chargebee.com/docs/bulk-operations.html).
                  enum:
                  - data
                  - import_friendly_data
                  example: null
                item_id:
                  type: object
                  deprecated: false
                  description: |
                    optional, string filter

                    The plan item code.
                    **Supported operators :**
                    is, is_not, starts_with, in, not_in

                    **Example →**
                    *item_id\[is\] = "silver"*
                  example: silver
                  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
                item_price_id:
                  type: object
                  deprecated: false
                  description: |
                    optional, string filter

                    The plan item price code.
                    **Supported operators :**
                    is, is_not, starts_with, in, not_in

                    **Example →**
                    *item_price_id\[is\] = "silver-USD-monthly"*
                  example: silver-USD-monthly
                  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 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
                    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: |
                        Time at which the subscription `status`
                        last changed to
                        `active`.
                        For example, this value is updated when an `in_trial`
                        or
                        `cancelled`
                        subscription activates.
                      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: |
                        The date/time at which the next billing for the subscription happens. This is usually right after `current_term_end`
                        unless multiple subscription terms were invoiced in advance using the `terms_to_charge`
                        parameter.
                      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: |
                        If `true`
                        , there are subscription changes scheduled on next renewal.
                      example: "true"
                      properties:
                        is:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          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. It is advisable when using this filter, to pass the `sort_by`
                        input parameter as `updated_at`
                        for a faster response.
                      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: |
                        Set to `false`
                        to override for this subscription, the [site-level setting](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing)
                        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 [customer level](/docs/api/customers/customer-object#auto_close_invoices)
                        .
                      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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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.\n* `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.\n* `play_store`\
                            \ -\n  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.  \n  In-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
                    decommissioned:
                      type: object
                      deprecated: false
                      description: Specifies whether a cancelled subscription is decommissioned
                        or not
                      example: "true"
                      properties:
                        is:
                          type: string
                          format: boolean
                          enum:
                          - "true"
                          - "false"
                          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: |
                      Resource object representing export
                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:
      tags:
      - full_exports
      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})))?::)))))$"
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  full_export:
                    $ref: "#/components/schemas/FullExport"
                    description: |
                      Resource object representing full_export
                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:
      tags:
      - payment_intents
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  payment_intent:
                    $ref: "#/components/schemas/PaymentIntent"
                    description: |
                      Resource object representing payment_intent
                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:
      tags:
      - payment_intents
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
                    * tamara - Payments made via Tamara.
                    * alipay_hk - Payments made via Alipay HK.
                    * ovo - Payments made via OVO.
                    * apple_pay - apple_pay
                    * cash_app_pay - Payments made via Cash App Pay.
                    * ideal - ideal
                    * bancontact - bancontact
                    * nequi - Payments made via Nequi.
                    * netbanking_emandates - netbanking_emandates
                    * pay_to - PayTo
                    * trustly - Trustly
                    * venmo - Venmo
                    * after_pay - Payments made via Afterpay
                    * alipay - Payments made via Alipay.
                    * picpay - Payments made via PicPay.
                    * dotpay - dotpay
                    * giropay - giropay
                    * fpx - Payments made via FPX.
                    * sofort - sofort
                    * momo - Payments made via MoMo.
                    * sepa_instant_transfer - Sepa Instant Transfer
                    * paypay - PayPay
                    * gcash - Payments made via GCash.
                    * mercado_pago - Payments made via Mercado Pago.
                    * nupay - Payments made via NuPay.
                    * kakao_pay - Payments made via Kakao Pay.
                    * blik - Payments made via BLIK.
                    * direct_debit - direct_debit
                    * dana - Payments made via Dana.
                    * paypal_express_checkout - paypal_express_checkout
                    * touch_n_go - Payments made via Touch 'n Go.
                    * boleto - boleto
                    * faster_payments - Faster Payments
                    * rakuten_pay - Payments made via Rakuten Pay.
                    * pix - Pix
                    * qpay - Payments made via Qpay.
                    * klarna_pay_now - Klarna Pay Now
                    * revolut_pay - Payments made via Revolut Pay.
                    * naver_pay - Payments made via Naver Pay.
                    * amazon_payments - Amazon Payments
                    * electronic_payment_standard - Electronic Payment Standard
                    * stablecoin - Payments made via Stablecoin.
                    * grab_pay - Payments made via GrabPay
                    * card - card
                    * upi - upi
                    * affirm_pay - Payments made via Affirm Pay.
                    * p24 - Payments made via Przelewy24 (P24).
                    * south_korean_cards - Payments made via South Korean Cards
                    * thai_qr - Payments made via Thai QR.
                    * online_banking_poland - Online Banking Poland
                    * klarna - Payments made via Klarna.
                    * wero - Payments made via Wero.
                    * pay_by_bank - Pay By Bank
                    * go_pay - Payments made via GoPay
                    * swish - Payments made via Swish
                    * 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.
                    * 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
                  - alipay_hk
                  - paypay
                  - gcash
                  - south_korean_cards
                  - paynow
                  - bizum
                  - promptpay
                  - dana
                  - touch_n_go
                  - tamara
                  - qpay
                  - ovo
                  - momo
                  - mercado_pago
                  - nequi
                  - nupay
                  - picpay
                  - thai_qr
                  - blik
                  - fpx
                  - wero
                  - p24
                  - affirm_pay
                  - rakuten_pay
                  example: null
                success_url:
                  type: string
                  deprecated: false
                  description: |
                    The URL the customer will be directed to once 3DS verification is successful. Applicable only when `payment_method_type`
                    is `ideal`
                    , `sofort`
                    , `dotpay`
                    or `giropay`
                    .
                  maxLength: 250
                  example: null
                failure_url:
                  type: string
                  deprecated: false
                  description: |
                    The URL the customer will be directed to when 3DS verification fails. Applicable only when `payment_method_type`
                    is `ideal`
                    , `sofort`
                    , `dotpay`
                    or `giropay`
                    .
                  maxLength: 250
                  example: null
                payment_method_options:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    Payment method-specific options for this PaymentIntent. Only `card` is supported; keys for other payment method types are ignored.

                    * `card`: Options for card payments.
                      * `three_d_secure`: Options for 3DS authentication.
                        * `challenge_preference`: The preferred 3DS flow. Applicable only when `payment_method_type` is `card` and 3DS is enabled for the gateway account. Supported for Stripe, Adyen, and BlueSnap; ignored for other gateways. The gateway or card issuer can override the preference.
                          * `no_preference`: Chargebee, the gateway, and the issuer decide the 3DS flow.
                          * `no_challenge`: Requests a frictionless flow without a challenge.
                          * `challenge`: Requests a challenge flow.

                    If not specified, the existing preference is retained. To clear it, pass `payment_method_options` with no `challenge_preference`.
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  payment_intent:
                    $ref: "#/components/schemas/PaymentIntent"
                    description: |
                      Resource object representing payment_intent
                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:
      tags:
      - payment_intents
      summary: Create a payment intent
      description: |
        Creates a PaymentIntent object. This is to be used with Chargebee.js API to complete the 3DS flow for new or stored cards.

        While creating, specify the appropriate gateway account and amount. Exact amount can be estimated using our [Estimate API](/docs/api/estimates).

        #### Customer resource lookup and creation

        When [customer[id]](/docs/api/payment_intents/create-a-payment-intent#customer_id) 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 `payment_intent` is created without any customer association and will be available for any customer.

        ##### Multiple business entities

        If multiple [business entities](/docs/api/advanced-features) are created for the site, the customer resource lookup and creation happen within the [context](/docs/api/advanced-features) of the business entity [specified](/docs/api/advanced-features#mbe-header-main) in this API call. If no business entity is specified, the customer resource lookup is performed within the [site context](/docs/api/advanced-features), and if not found, the resource is created for the [default business entity](/docs/api/advanced-features) of the site.
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                business_entity_id:
                  type: string
                  deprecated: false
                  description: "Sets the [context]() for this operation to the [business\
                    \ entity](/docs/api/advanced-features) specified. Applicable only\
                    \ when multiple business entities have been created for the site.\
                    \ When this parameter is provided, the operation is able to read/write\
                    \ data associated only to the business entity specified. When\
                    \ not provided, the operation can read/write data for the entire\
                    \ site.  \n**Note**\n\nAn alternative way of passing this parameter\
                    \ is by means of a [custom HTTP header](/docs/api/advanced-features).\
                    \  \n**See also**\n[Customer resource lookup and creation.](/docs/api/payment_intents)\n"
                  maxLength: 50
                  example: null
                brand_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [brand](/docs/api/brands) this\
                    \ payment intent should be linked to. Applicable only when multiple\
                    \ brands have been created for the site. An alternative way of\
                    \ passing this parameter is by means of the `chargebee-brand-id`\
                    \ custom HTTP header; when both are provided, they must specify\
                    \ the same brand.  \n**Default behavior**\n\n* When not provided,\
                    \ the payment intent is linked to the brand of the customer it\
                    \ is created for, or to the default brand defined for the site\
                    \ when no customer is specified.\n"
                  maxLength: 50
                  example: null
                customer_id:
                  type: string
                  deprecated: false
                  description: "The unique identifier of the customer for whom the\
                    \ `payment_intent` will be created. If specified, the `payment_intent`\
                    \ will be used exclusively for that customer. If not specified,\
                    \ the `payment_intent` won't be associated with any customer and\
                    \ will be available for any customer.  \n**See also**\n\n[Customer\
                    \ resource lookup and creation](/docs/api/payment_intents)\n.\n"
                  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
                  description: |
                    When set to `true`, the binding of the payment method type and related fields is deferred during intent creation. As a result, fields such as `gateway_account_id`, `gateway`, `payment_method_type`, and `reference_id` provided in this request will be ignored until the intent is updated with a selected payment method.
                  example: null
                payment_method_type:
                  type: string
                  default: card
                  deprecated: false
                  description: "The payment method of this intent.\n\n* google_pay\
                    \ - google_pay\n* pay_co - Payments made via PayCo\n* tamara -\
                    \ Payments made via Tamara.\n* alipay_hk - Payments made via Alipay\
                    \ HK.\n* ovo - Payments made via OVO.\n* apple_pay - apple_pay\n\
                    * cash_app_pay - Payments made via Cash App Pay.\n* ideal - ideal\n\
                    * bancontact - bancontact\n* nequi - Payments made via Nequi.\n\
                    * netbanking_emandates - netbanking_emandates\n* pay_to - PayTo\n\
                    * trustly - Trustly\n* venmo - Venmo\n* after_pay - Payments made\
                    \ via Afterpay\n* alipay - Payments made via Alipay.\n* picpay\
                    \ - Payments made via PicPay.\n* dotpay - dotpay\n* giropay -\
                    \ giropay\n* fpx - Payments made via FPX.\n* sofort - sofort\n\
                    * momo -\n  Payments made via MoMo.  \n  **Constraints**\n\n \
                    \ * The payment intent currency must be `VND`.\n* sepa_instant_transfer\
                    \ - Sepa Instant Transfer\n* paypay - PayPay\n* gcash - Payments\
                    \ made via GCash.\n* mercado_pago - Payments made via Mercado\
                    \ Pago.\n* nupay - Payments made via NuPay.\n* kakao_pay - Payments\
                    \ made via Kakao Pay.\n* blik - Payments made via BLIK.\n* direct_debit\
                    \ - direct_debit\n* dana - Payments made via Dana.\n* paypal_express_checkout\
                    \ - paypal_express_checkout\n* touch_n_go - Payments made via\
                    \ Touch 'n Go.\n* boleto - boleto\n* faster_payments - Faster\
                    \ Payments\n* rakuten_pay -\n  Payments made via Rakuten Pay.\
                    \  \n  **Constraints**\n\n  * The payment intent currency must\
                    \ be `JPY`.\n* pix - Pix\n* qpay - Payments made via Qpay.\n*\
                    \ klarna_pay_now - Klarna Pay Now\n* revolut_pay - Payments made\
                    \ via Revolut Pay.\n* naver_pay - Payments made via Naver Pay.\n\
                    * amazon_payments - Amazon Payments\n* electronic_payment_standard\
                    \ - Electronic Payment Standard\n* stablecoin - Payments made\
                    \ via Stablecoin.\n* grab_pay - Payments made via GrabPay\n* card\
                    \ - card\n* upi - upi\n* affirm_pay - Payments made via Affirm\
                    \ Pay.\n* p24 - Payments made via Przelewy24 (P24).\n* south_korean_cards\
                    \ - Payments made via South Korean Cards\n* thai_qr - Payments\
                    \ made via Thai QR.\n* online_banking_poland - Online Banking\
                    \ Poland\n* klarna - Payments made via Klarna.\n* wero - Payments\
                    \ made via Wero.\n* pay_by_bank - Pay By Bank\n* go_pay - Payments\
                    \ made via GoPay\n* swish - Payments made via Swish\n* payconiq_by_bancontact\
                    \ - Payments made via Payconiq by Bancontact.\n* twint - Payments\
                    \ made via Twint\n* payme - Payments made via PayMe\n* wechat_pay\
                    \ - Payments made via WeChat Pay.\n* kbc_payment_button - KBC\
                    \ Payment Button\n"
                  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
                  - alipay_hk
                  - paypay
                  - gcash
                  - south_korean_cards
                  - paynow
                  - bizum
                  - promptpay
                  - dana
                  - touch_n_go
                  - tamara
                  - qpay
                  - ovo
                  - momo
                  - mercado_pago
                  - nequi
                  - nupay
                  - picpay
                  - thai_qr
                  - blik
                  - fpx
                  - wero
                  - p24
                  - affirm_pay
                  - rakuten_pay
                  example: null
                success_url:
                  type: string
                  deprecated: false
                  description: |
                    The URL the customer will be directed to once 3DS verification is successful. Applicable only when `payment_method_type`
                    is `ideal`
                    , `sofort`
                    , `dotpay`
                    or `giropay`
                    .
                  maxLength: 250
                  example: null
                failure_url:
                  type: string
                  deprecated: false
                  description: |
                    The URL the customer will be directed to when 3DS verification fails. Applicable only when `payment_method_type`
                    is `ideal`
                    , `sofort`
                    , `dotpay`
                    or `giropay`
                    .
                  maxLength: 250
                  example: null
                payment_method_options:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    Payment method-specific options for this PaymentIntent. Only `card` is supported; keys for other payment method types are ignored.

                    * `card`: Options for card payments.
                      * `three_d_secure`: Options for 3DS authentication.
                        * `challenge_preference`: The preferred 3DS flow. Applicable only when `payment_method_type` is `card` and 3DS is enabled for the gateway account. Supported for Stripe, Adyen, and BlueSnap; ignored for other gateways. The gateway or card issuer can override the preference.
                          * `no_preference`: Chargebee, the gateway, and the issuer decide the 3DS flow.
                          * `no_challenge`: Requests a frictionless flow without a challenge.
                          * `challenge`: Requests a challenge flow.
                  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: |
                      Resource object representing payment_intent
                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:
      tags:
      - custom_field_configs
      summary: Retrieve a custom field configuration
      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.
          * coupon - Entity that represents a discount coupon.
          * 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.
          * quote - Entity that represents a quote.
          * 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
          - item_family
          - plan_item
          - addon_item
          - charge_item
          - plan_price
          - addon_price
          - charge_price
          - coupon
          - quote
          example: null
      - name: api_name
        in: query
        description: |
          Custom field identifier.
        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})))?::)))))$"
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  custom_field_config:
                    $ref: "#/components/schemas/CustomFieldConfig"
                    description: |
                      Resource object representing custom_field_config.
                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:
      tags:
      - custom_field_configs
      summary: List custom field configurations
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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.
          * coupon - Entity that represents a discount coupon.
          * 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.
          * quote - Entity that represents a quote.
          * 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
          - item_family
          - 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: []
  /item_families/{item-family-id}/delete:
    post:
      tags:
      - item_families
      summary: Delete an item family
      description: |
        Deletes an item family, marking its `status`
        as `deleted`
        . This is not allowed if there are `active`
        items under the item family. Once deleted, the `id`
        and `name`
        of the item family can be reused to create a new item family.
      operationId: delete_an_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: item-family-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/item-family-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  item_family:
                    $ref: "#/components/schemas/ItemFamily"
                    description: |
                      Resource object representing item_family
                required:
                - 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: []
  /item_families:
    get:
      tags:
      - item_families
      summary: List item families
      description: |
        Returns a list of item families satisfying **all**
        the conditions specified in the filter parameters below. The list is sorted by date of creation, in descending order.
      operationId: list_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: id
        in: query
        description: |
          optional, string filter

          The identifier for the item family. It is unique and immutable.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *id\[is\] = "family-id"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: family-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
            in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
            not_in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
      - name: name
        in: query
        description: |
          optional, string filter

          A unique display name for the item family. This is visible only in Chargebee and not to customers.
          **Supported operators :**
          is, is_not, starts_with

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

          When the item family was last updated.
          **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: business_entity_id
        in: query
        description: |
          optional, string filter

          The unique ID of the
          [business entity](/docs/api/business_entities)
          of this `item_family`.
          [Learn more](/docs/api/using_business_entity_filters_in_product_catalog_list_apis)
          about all the scenarios before using this filter.

          **Supported operators :**
          is, is_present

          **Example →**
          *business_entity_id\[is_present\] = "true"*
        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
            is_present:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
      - name: include_site_level_resources
        in: query
        description: |
          optional, boolean filter

          Default value is `true` . To exclude site-level resources in [specific cases](), set this parameter to `false`.
          Possible values are : *true, false*

          **Supported operators :**
          is

          **Example →**
          *include_site_level_resources\[is\] = "null"*
        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:
                        item_family:
                          $ref: "#/components/schemas/ItemFamily"
                          description: Resource object representing item_family
                      required:
                      - 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:
      tags:
      - item_families
      summary: Create an item family
      description: |
        This endpoint creates an item family for your product line or service.
      operationId: create_an_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
              properties:
                id:
                  type: string
                  deprecated: false
                  description: |
                    The identifier for the item family. Must be unique and is immutable.
                  maxLength: 50
                  example: null
                name:
                  type: string
                  deprecated: false
                  description: |
                    The display name for the item family. Must be unique. This is visible only in Chargebee and not to customers.
                  maxLength: 50
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    Description of the item family. This is visible only in Chargebee and not to customers.
                  maxLength: 500
                  example: null
                business_entity_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [business entity](/docs/api/business_entities)\n\
                    for this `item_family`.\nThis is applicable only when multiple\
                    \ business entities have been created for the site. When provided,\
                    \ the operation will read or write data associated with the specified\
                    \ business entity. If not provided, the resource will be created\
                    \ at the site level, and the `business_entity_id`\nwill not be\
                    \ included in the API response.  \n**Note**\nAn alternative way\
                    \ of passing this parameter is by means of a [custom HTTP header](/docs/api/advanced-features#mbe-header-main).\n"
                  maxLength: 50
                  example: null
              required:
              - id
              - name
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  item_family:
                    $ref: "#/components/schemas/ItemFamily"
                    description: |
                      Resource object representing item_family
                required:
                - 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: []
  /item_families/{item-family-id}:
    get:
      tags:
      - item_families
      summary: Retrieve an item family
      description: |
        This endpoint retrieves an item family based on the item family id.
      operationId: retrieve_an_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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: item-family-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/item-family-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  item_family:
                    $ref: "#/components/schemas/ItemFamily"
                    description: |
                      Resource object representing item_family
                required:
                - 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:
      tags:
      - item_families
      summary: Update an item family
      description: |
        This endpoint updates the name and/or description of the item family.
      operationId: update_an_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: item-family-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/item-family-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 for the item family. Must be unique. This is visible only in Chargebee and not to customers.
                  maxLength: 50
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    Description of the item family. This is visible only in Chargebee and not to customers.
                  maxLength: 500
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  item_family:
                    $ref: "#/components/schemas/ItemFamily"
                    description: |
                      Resource object representing item_family
                required:
                - 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: []
  /products/{product-id}:
    get:
      tags:
      - products
      summary: Retrieve a product
      description: |
        Retrieve a product using `product_id`
        .
      operationId: retrieve_a_product
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: product-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/product-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  product:
                    $ref: "#/components/schemas/Product"
                    description: |
                      Resource object representing product
                required:
                - product
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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:
      tags:
      - products
      summary: Update a product
      description: "This API allows you to update specific product details.\n\nThe\
        \ following table will help you to understand the status of the mapped [item](/docs/api/items/item-object#status)\
        \ and [item_price](/docs/api/item_prices/item_price-object#status) after passing\
        \ product [status](/docs/api/products/update-a-product#status) value during\
        \ product updation.  \n\n|-------------------------------------|--------------------------------|\n\
        | **Product Status**(Input parameter) | **Item and Item Price Status** |\n\
        | **active**                          | **active**                     |\n\
        | **inactive**                        | **archived**                   |\n\
        \n"
      operationId: update_a_product
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: product-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/product-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 unique internal name for the product. This is only visible in Chargebee.
                  maxLength: 100
                  example: null
                external_name:
                  type: string
                  deprecated: false
                  description: |
                    The unique name that appears for each product to the end user.
                  maxLength: 100
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    Description of the product.
                  maxLength: 500
                  example: null
                status:
                  type: string
                  default: active
                  deprecated: false
                  description: |
                    Status of the product. Refer to the [table](/docs/api/products/update-a-product)
                    for more information.

                    * active - The active products are visible on the storefront, subscription, or checkout.
                    * inactive - The inactive products are not visible on the storefront, subscription, or checkout.
                  enum:
                  - active
                  - inactive
                  example: null
                sku:
                  type: string
                  deprecated: false
                  description: |
                    A unique identifier code a seller assigns to each product or item. Retailers and merchants use SKUs to keep track of inventory and sales data and help organize products within a store or warehouse. SKUs can include a combination of letters, numbers, and symbols and can vary in length depending on the seller's needs.
                  maxLength: 100
                  example: null
                shippable:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |
                    Whether a product is shippable or not. Pass the value as `true`
                    if it is a shippable physical product, else pass the value as `false`
                    .
                  example: null
                metadata:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: "A collection of key-value pairs that provides extra\
                    \ information about the product.  \n**Note:**\nThere's a character\
                    \ limit of 65,535.\n\n[Learn more](/docs/api/advanced-features#metadata)\n\
                    .\n"
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  product:
                    $ref: "#/components/schemas/Product"
                    description: |
                      Resource object representing product
                required:
                - product
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /products/{product-id}/delete:
    post:
      tags:
      - products
      summary: Delete a product
      description: |
        This API deletes a product and changes the delete attribute value to `true`
        . Deletion of a product is not allowed if there are `active`
        or `archived`
        variants under the product or if there are items mapped to the product. Once deleted, the `name`
        of the product can be reused.
      operationId: delete_a_product
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: product-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/product-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  product:
                    $ref: "#/components/schemas/Product"
                    description: |
                      Resource object representing product
                required:
                - product
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /products/{product-id}/update_options:
    post:
      tags:
      - products
      summary: Add remove or update options for the product
      description: |
        This API allows you to add, remove, or update product options.
      operationId: add_remove_or_update_options_for_the_product
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: product-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/product-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                remove_options:
                  type: array
                  deprecated: false
                  description: |
                    List of options that you want to remove from the product. You can provide option names.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                options:
                  type: object
                  deprecated: false
                  description: |
                    The list of options that you want to add when the `options[name]`
                    are absent in a product, you can use this parameter to update the option values that already exist in a product.
                  properties:
                    name:
                      type: array
                      description: |
                        Unique name of the option.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    values:
                      type: array
                      description: |
                        List of possible values for the option. For example. if the option name is Size(options\[name\]\[1\]="Size"), then the values can be Small, Medium, and Large(options\[values\]\[1\]=\["Small", "Medium", "Large"\]).
                      items:
                        type: array
                        deprecated: false
                        items:
                          example: null
                        example: null
                      example: null
                    default_value:
                      type: array
                      description: |
                        Set the default value of an option.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                  required:
                  - name
                  example: null
              example: null
            encoding:
              options:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  product:
                    $ref: "#/components/schemas/Product"
                    description: |
                      Resource object representing product
                required:
                - product
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /products:
    get:
      tags:
      - products
      summary: List products
      description: |
        This API retrieves the list of products that are `active`
        or `inactive`
        . Use `include_deleted`
        parameter to include deleted products with `active`
        and `inactive`
        products.
      operationId: list_products
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: include_deleted
        in: query
        description: |
          If set to `true`
          , it includes the deleted products in the API response.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          example: null
      - name: id
        in: query
        description: |
          optional, string filter

          Filter product based on their [id](/docs/api/products)
          .
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *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: name
        in: query
        description: |
          optional, string filter

          Filter product based on their `name`
          s.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *name\[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

          Filter product based on their `status`.
          Possible values are : active, inactive.

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

          **Example →**
          *status\[is\] = "basic"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: basic
          properties:
            is:
              type: string
              description: |-
                * `active` - active
                * `inactive` - inactive
              enum:
              - active
              - inactive
              example: null
            is_not:
              type: string
              description: |-
                * `active` - active
                * `inactive` - inactive
              enum:
              - active
              - inactive
              example: null
            in:
              type: string
              description: |-
                * `active` - active
                * `inactive` - inactive
              enum:
              - active
              - inactive
              pattern: "^\\[(active|inactive)(,(active|inactive))*\\]$"
              example: null
            not_in:
              type: string
              description: |-
                * `active` - active
                * `inactive` - inactive
              enum:
              - active
              - inactive
              pattern: "^\\[(active|inactive)(,(active|inactive))*\\]$"
              example: null
      - name: shippable
        in: query
        description: |
          optional, boolean filter

          Filter product based on whether it is shippable or not. Possible values are : *true, false*

          **Supported operators :**
          is

          **Example →**
          *shippable\[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: has_variant
        in: query
        description: |
          optional, boolean filter

          Filter product based on whether it has variants or not. Possible values are : *true, false*

          **Supported operators :**
          is

          **Example →**
          *has_variant\[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: created_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          Filter product based on their `created time`
          .
          **Supported operators :**
          after, before, on, between

          **Example →**
          *created_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: updated_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          Filter product based on their `updated time`
          .
          **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 :**
          name, id, created_at, updated_at

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

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

          This will sort the result based on the 'name' attribute in ascending(earliest first) order.
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
          properties:
            asc:
              type: string
              enum:
              - name
              - id
              - created_at
              - updated_at
              example: null
            desc:
              type: string
              enum:
              - name
              - id
              - 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:
                        product:
                          $ref: "#/components/schemas/Product"
                          description: Resource object representing product
                      required:
                      - product
                      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:
      tags:
      - products
      summary: Create a product
      description: |
        This API creates a new product.
      operationId: create_a_product
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                name:
                  type: string
                  deprecated: false
                  description: |
                    A unique internal name for the product. This is only visible in Chargebee.
                  maxLength: 100
                  example: null
                external_name:
                  type: string
                  deprecated: false
                  description: |
                    The unique name that appears to the end user for each product.
                  maxLength: 100
                  example: null
                status:
                  type: string
                  default: active
                  deprecated: false
                  description: |
                    Status of the product.

                    * active - The active products are visible on the storefront, subscription, or checkout.
                    * inactive - The inactive products are not visible on the storefront, subscription, or checkout.
                  enum:
                  - active
                  - inactive
                  example: null
                id:
                  type: string
                  deprecated: false
                  description: |
                    The immutable unique identifier of the product. If not passed, it will get autogenerated.
                  maxLength: 100
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    Description of the product.
                  maxLength: 500
                  example: null
                sku:
                  type: string
                  deprecated: false
                  description: |
                    A unique identifier code a seller assigns to each product or item. Retailers and merchants use SKUs to keep track of inventory and sales data and help organize products within a store or warehouse. SKUs can include a combination of letters, numbers, and symbols and can vary in length depending on the seller's needs.
                  maxLength: 100
                  example: null
                metadata:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: "A collection of key-value pairs that provides extra\
                    \ information about the product.  \n**Note:**\nThere's a character\
                    \ limit of 65,535.\n\n[Learn more](/docs/api/advanced-features#metadata)\n\
                    .\n"
                  example: null
                shippable:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |
                    Whether a product is shippable or not. Pass the value as `true`
                    if it is a shippable physical product, else pass the value as `false`
                    .
                  example: null
              required:
              - external_name
              - name
              - status
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  product:
                    $ref: "#/components/schemas/Product"
                    description: |
                      Resource object representing product
                required:
                - product
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /products/{product-id}/variants:
    get:
      tags:
      - products
      summary: List product variants
      description: |
        This API retrieves the list of product variants.
      operationId: list_product_variants
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: product-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/product-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: include_deleted
        in: query
        description: |
          If set to `true`
          , it includes the deleted variants in the API response.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          example: null
      - name: id
        in: query
        description: |
          optional, string filter

          Filter variant based on their [id](/docs/api/variants)
          .
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *id\[is_not\] = "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: name
        in: query
        description: |
          optional, string filter

          Filter variant based on their `name`
          s.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *name\[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: sku
        in: query
        description: |
          optional, string filter

          Filter variant based on their `sku`
          .
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *sku\[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

          Filter variant based on their `status`.
          Possible values are : active, inactive.

          **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` - active
                * `inactive` - inactive
              enum:
              - active
              - inactive
              example: null
            is_not:
              type: string
              description: |-
                * `active` - active
                * `inactive` - inactive
              enum:
              - active
              - inactive
              example: null
            in:
              type: string
              description: |-
                * `active` - active
                * `inactive` - inactive
              enum:
              - active
              - inactive
              pattern: "^\\[(active|inactive)(,(active|inactive))*\\]$"
              example: null
            not_in:
              type: string
              description: |-
                * `active` - active
                * `inactive` - inactive
              enum:
              - active
              - inactive
              pattern: "^\\[(active|inactive)(,(active|inactive))*\\]$"
              example: null
      - name: updated_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          Filter product based on their `updated time`
          .
          **Supported operators :**
          after, before, on, between

          **Example →**
          *updated_at\[before\] = "basic"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: basic
          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

          Filter product based on their `created time`
          .
          **Supported operators :**
          after, before, on, between

          **Example →**
          *created_at\[before\] = "basic"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: basic
          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 :**
          name, id, status, created_at, updated_at

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

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

          This will sort the result based on the 'name' attribute in ascending(earliest first) order.
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
          properties:
            asc:
              type: string
              enum:
              - name
              - id
              - status
              - created_at
              - updated_at
              example: null
            desc:
              type: string
              enum:
              - name
              - id
              - status
              - 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:
                        variant:
                          $ref: "#/components/schemas/Variant"
                          description: Resource object representing variant
                      required:
                      - variant
                      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:
      tags:
      - products
      summary: Create a product variant
      description: |+
        This API is used for creating a new product variant.
        The following table will help you to understand the state of the variant `status` after passing [status](/docs/api/variants/create-a-product-variant#status) value during variant creation.

        * **Parameter Value** column holds possible inputs to the `variant.status`.

        * **Product Status** column states the status of the associated product.

        * **Variant Status** column states the value of the variant status once the variant is created.

        |------------------------------|--------------------|--------------------|
        | **Parameter Value**          | **Product Status** | **Variant Status** |
        | No value passed              | **active**         | **active**         |
        | No value passed              | **inactive**       | **inactive**       |
        | Value passed as **active**   | **active**         | **active**         |
        | Value passed as **inactive** | **active**         | **inactive**       |
        | Value passed as **active**   | **inactive**       | **not allowed**    |
        | Value passed as **inactive** | **inactive**       | **inactive**       |

      operationId: create_a_product_variant
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: product-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/product-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: |
                    The immutable unique identifier of a product variant. If not passed, it will get autogenerated.
                  maxLength: 100
                  example: null
                name:
                  type: string
                  deprecated: false
                  description: |
                    This is a unique name that appears for each product variant to the end user.
                  maxLength: 100
                  example: null
                external_name:
                  type: string
                  deprecated: false
                  description: |
                    The unique name that appears for each product variant to the end user.
                  maxLength: 100
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    A detailed description of this product variant.
                  maxLength: 500
                  example: null
                sku:
                  type: string
                  deprecated: false
                  description: |
                    A unique identifier code a seller assigns to each product variant. Retailers and merchants use SKUs to keep track of inventory and sales data and help organize products within a store or warehouse. SKUs can include a combination of letters, numbers, and symbols and can vary in length depending on the seller's needs.
                  maxLength: 100
                  example: null
                metadata:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: "A collection of key-value pairs that provides extra\
                    \ information about the product.  \n**Note:**\nThere's a character\
                    \ limit of 65,535.\n\n[Learn more](/docs/api/advanced-features#metadata)\n\
                    .\n"
                  example: null
                status:
                  type: string
                  deprecated: false
                  description: |
                    Status of the product variant. Refer to the [table](/docs/api/variants/create-a-product-variant)
                    for more information.

                    * active - The active product variants are visible on the storefront, subscription, or checkout.
                    * inactive - The inactive product variants are not visible on the storefront, subscription, or checkout.
                  enum:
                  - active
                  - inactive
                  example: null
                option_values:
                  type: object
                  deprecated: false
                  description: |
                    List of product variants option values.
                  properties:
                    name:
                      type: array
                      description: |
                        Name of the option values.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    value:
                      type: array
                      description: |
                        Pass values of the `option_values`
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                  required:
                  - name
                  - value
                  example: null
              required:
              - name
              example: null
            encoding:
              option_values:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  variant:
                    $ref: "#/components/schemas/Variant"
                    description: |
                      Resource object representing variant
                required:
                - variant
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /variants/{product-variant-id}:
    get:
      tags:
      - variants
      summary: Retrieve a product variant
      description: |
        This API is used to retrieve a product variant using `variant_id`
        .
      operationId: retrieve_a_product_variant
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: product-variant-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/product-variant-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  variant:
                    $ref: "#/components/schemas/Variant"
                    description: |
                      Resource object representing variant
                required:
                - variant
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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:
      tags:
      - variants
      summary: Update a product variant
      description: |
        This API is used to modify a product variant.
      operationId: update_a_product_variant
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: product-variant-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/product-variant-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: |
                    This is a unique name that appears for each product variant to the end user.
                  maxLength: 100
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    A detailed description of this product variant.
                  maxLength: 500
                  example: null
                status:
                  type: string
                  deprecated: false
                  description: |
                    Status of the product variant.

                    * active - The active product variants are visible on the storefront, subscription, or checkout.
                    * inactive - The inactive product variants are not visible on the storefront, subscription, or checkout.
                  enum:
                  - active
                  - inactive
                  example: null
                external_name:
                  type: string
                  deprecated: false
                  description: |
                    The unique name that appears for each product variant to the end user.
                  maxLength: 100
                  example: null
                sku:
                  type: string
                  deprecated: false
                  description: |
                    A unique identifier code a seller assigns to each product variant. Retailers and merchants use SKUs to keep track of inventory and sales data and help organize products within a store or warehouse. SKUs can include a combination of letters, numbers, and symbols and can vary in length depending on the seller's needs.
                  maxLength: 100
                  example: null
                metadata:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: "A collection of key-value pairs that provides extra\
                    \ information about the variant.  \n**Note:**\nThere's a character\
                    \ limit of 65,535.\n\n[Learn more](/docs/api/advanced-features#metadata)\n\
                    .\n"
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  variant:
                    $ref: "#/components/schemas/Variant"
                    description: |
                      Resource object representing variant
                required:
                - variant
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /variants/{product-variant-id}/delete:
    post:
      tags:
      - variants
      summary: Delete a product variant
      description: |
        This API deletes a product variant and returns the delete attribute value as `true`
        . Deletion of a product variant is not allowed if there are `active`
        or `archived`
        `item_price_id`
        under the variant. Once the variant is deleted, the `id`
        and `name`
        of the product variant can be reused.
      operationId: delete_a_product_variant
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: product-variant-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/product-variant-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  variant:
                    $ref: "#/components/schemas/Variant"
                    description: |
                      Resource object representing variant
                required:
                - variant
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /items:
    get:
      tags:
      - items
      summary: List items
      description: "Returns a list of items satisfying **all**\nthe conditions specified\
        \ in the filter parameters below. The list is sorted by date of creation,\
        \ in descending order.  \n\n### Use Cases\n\n##### Filter by custom fields\n\
        \n**Note:** Custom field filters are turned off by default. To turn them on\
        \ for your site, 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\
        \nYou can filter the response by [custom fields](/docs/api/advanced-features#filtering-by-custom-field-values)\
        \ configured on items. After they're turned on for your site, the filter parameters\
        \ are visible on this page when you're logged in. For the supported operators\
        \ and limits, see [Filtering by custom field values](/docs/api/advanced-features#filtering-by-custom-field-values).\n\
        \nItems can be one of three types: `plan`, `addon`, or `charge`. Each type\
        \ can have its own custom fields, so the filter parameter is scoped per item\
        \ type rather than shared across items.\n\nUse one of the following forms,\
        \ where `cf_CUSTOM_FIELD_NAME` is the exact, case-sensitive API name of a\
        \ custom field configured on the corresponding item type:\n\n```bg-gray-100\
        \ text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1\
        \ text-sm font-mono whitespace-nowrap\nplan_item[cf_CUSTOM_FIELD_NAME][OPERATOR]=VALUE\n\
        addon_item[cf_CUSTOM_FIELD_NAME][OPERATOR]=VALUE\ncharge_item[cf_CUSTOM_FIELD_NAME][OPERATOR]=VALUE\n\
        ```\n\nFor example, to filter plan items by the custom field `cf_package_id`,\
        \ pass it as a query parameter:\n\n```bash\ncurl https://{site}.chargebee.com/api/v2/items\
        \ \\\n    -G -u {site_api_key}: \\\n    -d plan_item[cf_package_id][is]=\"\
        pkg-basic\"\n```\n\n"
      operationId: list_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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: id
        in: query
        description: |
          optional, string filter

          Filter items based on item id.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *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: item_family_id
        in: query
        description: |
          optional, string filter

          Filter items based on `item_family_id`
          .
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *item_family_id\[is\] = "acme"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: acme
          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

          Filter items based on item `type`.
          Possible values are : plan, addon, charge.

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

          **Example →**
          *type\[is\] = "plan"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: plan
          properties:
            is:
              type: string
              description: |
                * `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.
                * `addon` - A recurring component that can be added to a subscription in addition to its plan.
                * `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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.
              enum:
              - plan
              - addon
              - charge
              example: null
            is_not:
              type: string
              description: |
                * `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.
                * `addon` - A recurring component that can be added to a subscription in addition to its plan.
                * `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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.
              enum:
              - plan
              - addon
              - charge
              example: null
            in:
              type: string
              description: |
                * `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.
                * `addon` - A recurring component that can be added to a subscription in addition to its plan.
                * `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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.
              enum:
              - plan
              - addon
              - charge
              pattern: "^\\[(plan|addon|charge)(,(plan|addon|charge))*\\]$"
              example: null
            not_in:
              type: string
              description: |
                * `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.
                * `addon` - A recurring component that can be added to a subscription in addition to its plan.
                * `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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.
              enum:
              - plan
              - addon
              - charge
              pattern: "^\\[(plan|addon|charge)(,(plan|addon|charge))*\\]$"
              example: null
      - name: name
        in: query
        description: |
          optional, string filter

          Filter items based on item `name`
          .
          **Supported operators :**
          is, is_not, starts_with

          **Example →**
          *name\[is_not\] = "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
      - name: item_applicability
        in: query
        description: |
          optional, enumerated string filter

          Filter items based on `item_applicability`.
          Possible values are : all, restricted.

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

          **Example →**
          *item_applicability\[is_not\] = "all"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: all
          properties:
            is:
              type: string
              description: |
                * `all` - all addon-items and charge-items are applicable to this plan-item.
                * `restricted` - only the addon-items or charge-items provided in `applicable_items` can be applied to this plan-item.
              enum:
              - all
              - restricted
              example: null
            is_not:
              type: string
              description: |
                * `all` - all addon-items and charge-items are applicable to this plan-item.
                * `restricted` - only the addon-items or charge-items provided in `applicable_items` can be applied to this plan-item.
              enum:
              - all
              - restricted
              example: null
            in:
              type: string
              description: |
                * `all` - all addon-items and charge-items are applicable to this plan-item.
                * `restricted` - only the addon-items or charge-items provided in `applicable_items` can be applied to this plan-item.
              enum:
              - all
              - restricted
              pattern: "^\\[(all|restricted)(,(all|restricted))*\\]$"
              example: null
            not_in:
              type: string
              description: |
                * `all` - all addon-items and charge-items are applicable to this plan-item.
                * `restricted` - only the addon-items or charge-items provided in `applicable_items` can be applied to this plan-item.
              enum:
              - all
              - restricted
              pattern: "^\\[(all|restricted)(,(all|restricted))*\\]$"
              example: null
      - name: status
        in: query
        description: |
          optional, enumerated string filter

          Filter items based on item `status`.
          Possible values are : active, archived.

          **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` - The item can be used to create new item prices.
                * `archived` - The item is no longer active and no new item prices can be created
                * `deleted` - Indicates that the item has been [deleted](./items?prod_cat_ver=2#delete_an_item). The `id` and `name` can be reused. Deleted items can be retrieved using [List items](./items?prod_cat_ver=2#list_items).
              enum:
              - active
              - archived
              - deleted
              example: null
            is_not:
              type: string
              description: |
                * `active` - The item can be used to create new item prices.
                * `archived` - The item is no longer active and no new item prices can be created
                * `deleted` - Indicates that the item has been [deleted](./items?prod_cat_ver=2#delete_an_item). The `id` and `name` can be reused. Deleted items can be retrieved using [List items](./items?prod_cat_ver=2#list_items).
              enum:
              - active
              - archived
              - deleted
              example: null
            in:
              type: string
              description: |
                * `active` - The item can be used to create new item prices.
                * `archived` - The item is no longer active and no new item prices can be created
                * `deleted` - Indicates that the item has been [deleted](./items?prod_cat_ver=2#delete_an_item). The `id` and `name` can be reused. Deleted items can be retrieved using [List items](./items?prod_cat_ver=2#list_items).
              enum:
              - active
              - archived
              - deleted
              pattern: "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                * `active` - The item can be used to create new item prices.
                * `archived` - The item is no longer active and no new item prices can be created
                * `deleted` - Indicates that the item has been [deleted](./items?prod_cat_ver=2#delete_an_item). The `id` and `name` can be reused. Deleted items can be retrieved using [List items](./items?prod_cat_ver=2#list_items).
              enum:
              - active
              - archived
              - deleted
              pattern: "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\\
                ]$"
              example: null
      - name: is_giftable
        in: query
        description: |
          optional, boolean filter

          Specifies if gift subscriptions can be created for this item. Possible values are : *true, false*

          **Supported operators :**
          is

          **Example →**
          *is_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: updated_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          Filter items based on when the items were last updated.
          **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: enabled_for_checkout
        in: query
        description: |
          optional, boolean filter

          Allow the plan to subscribed to via Checkout. Applies only for plan-items.
          **Note:**
          Only the in-app layout of Checkout is supported. Possible values are : *true, false*

          **Supported operators :**
          is

          **Example →**
          *enabled_for_checkout\[is\] = "null"*
        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
      - name: enabled_in_portal
        in: query
        description: |
          optional, boolean filter

          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).
          Possible values are : *true, false*

          **Supported operators :**
          is

          **Example →**
          *enabled_in_portal\[is\] = "null"*
        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
      - name: metered
        in: query
        description: |
          optional, boolean filter

          Specifies whether the item undergoes metered billing. When `true`, the quantity is calculated from [usage records](/docs/api/usages). When `false`, the `quantity` is as determined while adding an item price to the subscription. Applicable only for items of `type` `plan` or `addon` and when [Metered Billing](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing) is enabled. The value of this attribute cannot be changed. Possible values are : *true, false*

          **Supported operators :**
          is

          **Example →**
          *metered\[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: usage_calculation
        in: query
        description: |
          optional, enumerated string filter

          How the quantity is calculated from usage data for the item prices belonging to this item. Only applicable when the item is `metered`.
          This value overrides the one [set at the site level](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing).
          Possible values are : sum_of_usages, last_usage, max_usage.

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

          **Example →**
          *usage_calculation\[is_not\] = "SUM_OF_USAGES"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: SUM_OF_USAGES
          properties:
            is:
              type: string
              description: |
                * `sum_of_usages` - the net quantity is the sum of the `quantity` of all usages for the current term.
                * `last_usage` - from among the usage records for the [item price](/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id) with `usage_date` within the relevant billing period, the `quantity` of the usage record with the most recent `usage_date` is taken as the net quantity consumed.
                * `max_usage` - from among the usage records for the [item price](/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id) with `usage_date` within the relevant billing period, the `quantity` of the usage record with the maximum value is taken as the net quantity consumed.
              enum:
              - sum_of_usages
              - last_usage
              - max_usage
              example: null
            is_not:
              type: string
              description: |
                * `sum_of_usages` - the net quantity is the sum of the `quantity` of all usages for the current term.
                * `last_usage` - from among the usage records for the [item price](/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id) with `usage_date` within the relevant billing period, the `quantity` of the usage record with the most recent `usage_date` is taken as the net quantity consumed.
                * `max_usage` - from among the usage records for the [item price](/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id) with `usage_date` within the relevant billing period, the `quantity` of the usage record with the maximum value is taken as the net quantity consumed.
              enum:
              - sum_of_usages
              - last_usage
              - max_usage
              example: null
            in:
              type: string
              description: |
                * `sum_of_usages` - the net quantity is the sum of the `quantity` of all usages for the current term.
                * `last_usage` - from among the usage records for the [item price](/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id) with `usage_date` within the relevant billing period, the `quantity` of the usage record with the most recent `usage_date` is taken as the net quantity consumed.
                * `max_usage` - from among the usage records for the [item price](/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id) with `usage_date` within the relevant billing period, the `quantity` of the usage record with the maximum value is taken as the net quantity consumed.
              enum:
              - sum_of_usages
              - last_usage
              - max_usage
              pattern: "^\\[(sum_of_usages|last_usage|max_usage)(,(sum_of_usages|last_usage|max_usage))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                * `sum_of_usages` - the net quantity is the sum of the `quantity` of all usages for the current term.
                * `last_usage` - from among the usage records for the [item price](/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id) with `usage_date` within the relevant billing period, the `quantity` of the usage record with the most recent `usage_date` is taken as the net quantity consumed.
                * `max_usage` - from among the usage records for the [item price](/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id) with `usage_date` within the relevant billing period, the `quantity` of the usage record with the maximum value is taken as the net quantity consumed.
              enum:
              - sum_of_usages
              - last_usage
              - max_usage
              pattern: "^\\[(sum_of_usages|last_usage|max_usage)(,(sum_of_usages|last_usage|max_usage))*\\\
                ]$"
              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.\n* `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.\n* `play_store` -\n  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.  \n  In-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.\n* `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.\n* `play_store` -\n  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.  \n  In-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.\n* `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.\n* `play_store` -\n  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.  \n  In-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.\n* `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.\n* `play_store` -\n  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.  \n  In-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

          The unique ID of the
          [business entity](/docs/api/business_entities)
          of this `item`.
          [Learn more](/docs/api/using_business_entity_filters_in_product_catalog_list_apis)
          about all the scenarios before using this filter.

          **Supported operators :**
          is, is_present

          **Example →**
          *business_entity_id\[is_present\] = "true"*
        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
            is_present:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
      - name: include_site_level_resources
        in: query
        description: |
          optional, boolean filter

          Default value is `true` . To exclude site-level resources in [specific cases](), set this parameter to `false`.
          Possible values are : *true, false*

          **Supported operators :**
          is

          **Example →**
          *include_site_level_resources\[is\] = "null"*
        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
      - name: sort_by
        in: query
        description: |
          optional, string filter

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

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

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

          This will sort the result based on the 'name' attribute in ascending(earliest first) order.
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
          properties:
            asc:
              type: string
              enum:
              - name
              - id
              - updated_at
              example: null
            desc:
              type: string
              enum:
              - name
              - id
              - updated_at
              example: null
          example: null
      - name: bundle_configuration
        in: query
        description: |
          Parameters of `bundle_configuration`
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            type:
              type: object
              deprecated: false
              description: |
                Type of the bundle
              example: fixed
              properties:
                is:
                  type: string
                  description: |
                    * `fixed` - Fixed `bundle_configurations.type` appears when you create a bundle plan that cannot be updated during checkout or subscription creation.
                  enum:
                  - fixed
                  example: null
                is_not:
                  type: string
                  description: |
                    * `fixed` - Fixed `bundle_configurations.type` appears when you create a bundle plan that cannot be updated during checkout or subscription creation.
                  enum:
                  - fixed
                  example: null
                in:
                  type: string
                  description: |
                    * `fixed` - Fixed `bundle_configurations.type` appears when you create a bundle plan that cannot be updated during checkout or subscription creation.
                  enum:
                  - fixed
                  pattern: "^\\[(fixed)(,(fixed))*\\]$"
                  example: null
                not_in:
                  type: string
                  description: |
                    * `fixed` - Fixed `bundle_configurations.type` appears when you create a bundle plan that cannot be updated during checkout or subscription creation.
                  enum:
                  - fixed
                  pattern: "^\\[(fixed)(,(fixed))*\\]$"
                  example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        item:
                          $ref: "#/components/schemas/Item"
                          description: Resource object representing item
                      required:
                      - 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:
      tags:
      - items
      summary: Create an item
      description: |
        Creates a new item.
      operationId: create_an_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
              properties:
                id:
                  type: string
                  deprecated: false
                  description: |
                    The identifier for the item. Must be unique and is immutable once set.
                  maxLength: 100
                  example: null
                name:
                  type: string
                  deprecated: false
                  description: |
                    A unique display name for the item. Must be unique. This is visible only in Chargebee and not to customers.
                  maxLength: 100
                  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
                description:
                  type: string
                  deprecated: false
                  description: |
                    Description of the item. This is visible only in Chargebee and not to customers.
                  maxLength: 2000
                  example: null
                item_family_id:
                  type: string
                  deprecated: false
                  description: |
                    The `id`
                    of the [Item family](/docs/api/item_families)
                    that the item belongs to. Is mandatory when [Product Families](https://www.chargebee.com/docs/2.0/product-families.html)
                    have been enabled.
                  maxLength: 100
                  example: null
                is_giftable:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Specifies if gift subscriptions can be created for this item.
                  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
                external_name:
                  type: string
                  deprecated: false
                  description: |
                    A unique display name for the item.
                  maxLength: 100
                  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).
                    Only the in-app version of the Portal is supported for Product Catalog v2.
                  example: null
                redirect_url:
                  type: string
                  deprecated: false
                  description: |
                    If `enabled_for_checkout`
                    , then the URL to be redirected to once the checkout is complete. This attribute is only available for plan-items.
                  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.
                    **Note:**
                    Only the in-app layout of Checkout is supported.
                  example: null
                item_applicability:
                  type: string
                  default: all
                  deprecated: false
                  description: |
                    Indicates which addon-items and charge-items can be applied to the item. Only possible 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 [Create](/docs/api/attached_items/create-an-attached-item)
                    or [Update an attached item](/docs/api/attached_items/update-an-attached-item)
                    API.

                    * all - all addon-items and charge-items are applicable to this plan-item.
                    * restricted -
                      only the addon-items or charge-items provided in `applicable_items`
                      can be applied to this plan-item.
                  enum:
                  - all
                  - restricted
                  example: null
                applicable_items:
                  type: array
                  deprecated: false
                  description: |
                    The list of ids of addon-items and charge-items that can be applied to the plan-item. This parameter can be provided only for plan-items and that too when item_applicability is restricted. Other details of attaching items can be specified using the [Create](/docs/api/attached_items/create-an-attached-item)
                    or [Update an attached item](/docs/api/attached_items/update-an-attached-item)
                    API.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  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
                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
                included_in_mrr:
                  type: boolean
                  deprecated: false
                  description: |
                    The item is included in MRR calculations for your site. This attribute is only applicable for items of `type = charge`
                    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 `false`
                    .
                  example: null
                metered:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Specifies whether the item undergoes usage-based or metered billing. [Usage Based Billing](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/understanding-usages) or [Metered Billing](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing) must be enabled on your site to set `metered` to `true`.

                    **Usage Based Billing**

                    When Usage Based Billing is enabled, `metered` is applicable only for items of `type` `addon`. When `true`, the quantity is calculated from [usage events](/docs/api/usage_events/create-a-usage-event). When `false`, you must provide the quantity when adding an [item price](/docs/api/item_prices) that belongs to this item to a subscription (for example, when [creating](/docs/api/subscriptions/create-subscription-for-items#subscription_items_quantity) or [updating](/docs/api/subscriptions/update-subscription-for-items#subscription_items_quantity) the subscription).

                    **Metered Billing**

                    When Metered Billing is enabled, `metered` is applicable only for items of `type` `plan` or `addon`. When `true`, the quantity is calculated from [usage records](/docs/api/usages). When `false`, you must provide the quantity when adding an [item price](/docs/api/item_prices) that belongs to this item to a subscription (for example, when [creating](/docs/api/subscriptions/create-subscription-for-items#subscription_items_quantity) or [updating](/docs/api/subscriptions/update-subscription-for-items#subscription_items_quantity) the subscription).
                  example: null
                usage_calculation:
                  type: string
                  deprecated: false
                  description: |
                    How the quantity is calculated from usage data for the item prices belonging to this item. Only applicable when the item is `metered`.
                    This value overrides the one [set at the site level](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing).
                    .

                    * sum_of_usages -
                      the net quantity is the sum of the `quantity`
                      of all usages for the current term.
                    * last_usage -
                      from among the usage records for the [item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                      with `usage_date`
                      within the relevant billing period, the `quantity`
                      of the usage record with the most recent `usage_date`
                      is taken as the net quantity consumed.
                    * max_usage -
                      from among the usage records for the [item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                      with `usage_date`
                      within the relevant billing period, the `quantity`
                      of the usage record with the maximum value is taken as the net quantity consumed.
                  enum:
                  - sum_of_usages
                  - last_usage
                  - max_usage
                  example: null
                is_percentage_pricing:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Indicates whether the pricing is percentage-based.
                  example: null
                metadata:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: "A collection of key-value pairs that provides extra\
                    \ information about the item.  \n**Note:**\nThere's a character\
                    \ limit of 65,535.\n\n[Learn more](/docs/api/advanced-features#metadata).\n"
                  example: null
                business_entity_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [business entity](/docs/api/business_entities)\n\
                    for this `item`.\nThis is applicable only when multiple business\
                    \ entities have been created for the site. When provided, the\
                    \ operation will read or write data associated with the specified\
                    \ business entity. If not provided, the resource will be created\
                    \ at the site level, and the `business_entity_id`\nwill not be\
                    \ included in the API response.  \n**Note**\nAn alternative way\
                    \ of passing this parameter is by means of a [custom HTTP header](/docs/api/advanced-features#mbe-header-main).\n"
                  maxLength: 50
                  example: null
                bundle_configuration:
                  type: object
                  deprecated: false
                  description: |
                    Parameters of `bundle_configuration`
                  properties:
                    type:
                      type: string
                      deprecated: false
                      description: |
                        Type of the bundle

                        * fixed -
                          Fixed `bundle_configuration.type`
                          appears when you create a [bundle plan](https://www.chargebee.com/docs/2.0/product-bundling-overview.html)
                          that cannot be updated during checkout or subscription creation.
                      enum:
                      - fixed
                      example: null
                  example: null
                bundle_items_to_add:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for `bundle_items_to_add`
                  properties:
                    item_id:
                      type: array
                      description: |
                        [`item_id`](/docs/api/items/item-object#id)
                        that needs to be added to the bundle.
                        **Note:**
                        This parameter is only applicable when the [`item_type`](/docs/api/items/item-object#type)
                        is `plan`
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    item_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          [`item_type`](/docs/api/items/item-object#type)
                          that can be added to the bundle.

                          * charge - A non-recurring component that can be added to a bundle plan.
                          * addon - A recurring component that can be added to a bundle plan.
                          * plan -
                            An essential component of the bundle plan.
                            **Note:**
                            At least one [`plan`](/docs/api/items/item-object#type)
                            item must be associated with the bundle.
                        enum:
                        - plan
                        - addon
                        - charge
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Quantity of the item(plan, addon, and charge) associated with the bundle.
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    price_allocation:
                      type: array
                      description: |
                        Price allocation of the item(plan, addon, and charge) associated with the bundle.
                      items:
                        type: number
                        format: decimal
                        deprecated: false
                        maximum: 100
                        minimum: 0
                        example: null
                      example: null
                  example: null
              required:
              - id
              - item_family_id
              - name
              - type
              example: null
            encoding:
              bundle_configuration:
                style: deepObject
                explode: true
              bundle_items_to_add:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  item:
                    $ref: "#/components/schemas/Item"
                    description: |
                      Resource object representing item
                required:
                - 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: []
  /items/{item-id}/delete:
    post:
      tags:
      - items
      summary: Delete an item
      description: |
        Deletes an item, marking its `status`
        as deleted. This is not allowed if there are `active`
        or `archived`
        item prices under the item. Once deleted, the id and name of the item can be reused.
      operationId: delete_an_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: item-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/item-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  item:
                    $ref: "#/components/schemas/Item"
                    description: |
                      Resource object representing item
                required:
                - 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: []
  /items/{item-id}:
    get:
      tags:
      - items
      summary: Retrieve an item
      description: |
        Retrieve an item resource.
      operationId: retrieve_an_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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: item-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/item-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  item:
                    $ref: "#/components/schemas/Item"
                    description: |
                      Resource object representing item
                required:
                - 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:
      tags:
      - items
      summary: Update an item
      description: |
        Updates an item with the changes specified. Unspecified item parameters are not modified.
      operationId: update_an_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: item-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/item-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 for the item. Must be unique. This is visible only in Chargebee and not to customers.
                  maxLength: 100
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: "Description of the item. This is visible only in Chargebee\
                    \ and not to customers.  \n**Note**:\n\n* The description field\
                    \ supports up to 2000 characters, including HTML tags. The inner\
                    \ text (excluding HTML tags) must not exceed 500 characters. For\
                    \ example: `- testing - desc `. Total with tags: 38 characters,\
                    \ inner text: 'testing desc' (12 characters).\n* If your input\
                    \ includes characters requiring sanitization, such as incomplete\
                    \ HTML tags, the sanitization process may alter the input and\
                    \ increase its length. If the sanitized content exceeds the allowed\
                    \ limit, the request will be rejected.\n"
                  maxLength: 2000
                  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
                external_name:
                  type: string
                  deprecated: false
                  description: |
                    A unique display name for the item.
                  maxLength: 100
                  example: null
                item_family_id:
                  type: string
                  deprecated: false
                  description: |
                    The `id`
                    of the [Item family](/docs/api/item_families)
                    that the item belongs to. Is mandatory when [Product Families](https://www.chargebee.com/docs/2.0/product-families.html)
                    have been enabled.
                  maxLength: 100
                  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
                redirect_url:
                  type: string
                  deprecated: false
                  description: |
                    If `enabled_for_checkout`
                    , then the URL to be redirected to once the checkout is complete. This parameter is only meant for plan-items.
                  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.
                    **Note:**
                    Only the in-app layout of Checkout is supported.
                  example: null
                item_applicability:
                  type: string
                  default: all
                  deprecated: false
                  description: |
                    Indicates which addon-items and charge-items can be applied to the item. Only possible 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 [Create](/docs/api/attached_items/create-an-attached-item)
                    or [Update an attached item](/docs/api/attached_items/update-an-attached-item)
                    API.

                    * all - all addon-items and charge-items are applicable to this plan-item.
                    * restricted -
                      only the addon-items or charge-items provided in `applicable_items`
                      can be applied to this plan-item.
                  enum:
                  - all
                  - restricted
                  example: null
                applicable_items:
                  type: array
                  deprecated: false
                  description: |
                    The list of ids of addon-items and charge-items that can be applied to the plan-item. This parameter can be provided only for plan-items and that too when item_applicability is restricted. Other details of attaching items can be specified using the [Create](/docs/api/attached_items/create-an-attached-item)
                    or [Update an attached item](/docs/api/attached_items/update-an-attached-item)
                    API.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  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
                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
                metadata:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    A collection of key-value pairs that provides extra information about the item. [Learn more](/docs/api/advanced-features#metadata)
                    .
                  example: null
                included_in_mrr:
                  type: boolean
                  deprecated: false
                  description: |
                    The item is included in MRR calculations for your site. This attribute is only applicable for items of `type = charge`
                    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 `false`
                    .
                  example: null
                status:
                  type: string
                  deprecated: false
                  description: |
                    The status of the item.

                    * active - The item can be used to create new item prices.
                    * archived - The item is no longer active and no new item prices can be created
                  enum:
                  - active
                  - archived
                  example: null
                is_percentage_pricing:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Indicates whether the pricing is percentage-based.
                  example: null
                bundle_configuration:
                  type: object
                  deprecated: false
                  description: |
                    Parameters of `bundle_configuration`
                  properties:
                    type:
                      type: string
                      deprecated: false
                      description: |
                        Type of the bundle

                        * fixed -
                          Fixed `bundle_configuration.type`
                          should be provided when you create a bundle plan that cannot be updated during checkout or subscription creation.
                      enum:
                      - fixed
                      example: null
                  example: null
                bundle_items_to_add:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for `bundle_items_to_add`
                  properties:
                    item_id:
                      type: array
                      description: |
                        [`item_id`](/docs/api/items/item-object#id)
                        that needs to be added to the bundle.
                        **Note:**
                        This parameter is only applicable when the [`item_type`](/docs/api/items/item-object#type)
                        is `plan`
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    item_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          [`item_type`](/docs/api/items/item-object#type)
                          that can be added to the bundle.

                          * charge - A non-recurring component that can be added to a bundle plan.
                          * addon - A recurring component that can be added to a bundle plan.
                          * plan -
                            An essential component of the bundle plan.
                            **Note:**
                            At least one plan item must be associated with the bundle.
                        enum:
                        - plan
                        - addon
                        - charge
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Quantity of the item(plan, addon, and charge) associated with the bundle.
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    price_allocation:
                      type: array
                      description: |
                        Price allocation of the item(plan, addon, and charge) associated with the bundle.
                      items:
                        type: number
                        format: decimal
                        deprecated: false
                        maximum: 100
                        minimum: 0
                        example: null
                      example: null
                  example: null
                bundle_items_to_update:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for bundle_items_to_update
                  properties:
                    item_id:
                      type: array
                      description: |
                        [`item_id`](/docs/api/items/item-object#id)
                        that needs to be updated from the bundle plan. This attribute is only applicable when the [`item_type`](/docs/api/items/item-object#type)
                        is `plan`
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    item_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          [`item_type`](/docs/api/items/item-object#type)
                          that you want to update from the bundle.

                          * charge - A non-recurring component that can be added to a bundle plan.
                          * addon - A recurring component that can be added to a bundle plan.
                          * plan -
                            An essential component of the bundle plan.
                            **Note:**
                            At least one plan item must be associated with the bundle.
                        enum:
                        - plan
                        - addon
                        - charge
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Quantity of the item(plan, addon, and charge) associated with the bundle.
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    price_allocation:
                      type: array
                      description: |
                        Price allocation of the item(plan, addon, and charge) associated with the bundle.
                      items:
                        type: number
                        format: decimal
                        deprecated: false
                        maximum: 100
                        minimum: 0
                        example: null
                      example: null
                  example: null
                bundle_items_to_remove:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for bundle_items_to_remove
                  properties:
                    item_id:
                      type: array
                      description: |
                        [`item_id`](/docs/api/items/item-object#id)
                        that needs to be removed from the bundle plan.
                        **Note:**
                        This attribute is only applicable when the [`item_type`](/docs/api/items/item-object#type)
                        is `plan`
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    item_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          [`item_type`](/docs/api/items/item-object#type)
                          that you want to remove from the bundle.

                          * charge - A non-recurring component that can be added to a bundle plan.
                          * plan -
                            An essential component of the bundle plan.
                            **Note:**
                            At least one plan item must be associated with the bundle.
                          * addon - A recurring component that can be added to a bundle plan.
                        enum:
                        - plan
                        - addon
                        - charge
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              bundle_configuration:
                style: deepObject
                explode: true
              bundle_items_to_add:
                style: deepObject
                explode: true
              bundle_items_to_remove:
                style: deepObject
                explode: true
              bundle_items_to_update:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  item:
                    $ref: "#/components/schemas/Item"
                    description: |
                      Resource object representing item
                required:
                - 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: []
  /price_variants/{price-variant-id}/delete:
    post:
      tags:
      - price_variants
      summary: Delete a price variant
      description: |
        Deletes the price variant. This is not allowed if price variant is attached to any [item price](/docs/api/item_prices). Once deleted, the `id` and `name` of the price variant can be reused.
      operationId: delete_a_price_variant
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: price-variant-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/price-variant-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  price_variant:
                    $ref: "#/components/schemas/PriceVariant"
                    description: |
                      Resource object representing price_variant
                required:
                - price_variant
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /price_variants:
    get:
      tags:
      - price_variants
      summary: List price variants
      description: |
        This endpoint is used to retrieve a list of price variants.
      operationId: list_price_variants
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: id
        in: query
        description: |
          optional, string filter

          Filter variant based on their [id](/docs/api/price_variants)
          .
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *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: name
        in: query
        description: |
          optional, string filter

          Filter variant based on their `name`
          s.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *name\[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

          Filter variant based on their `status`.
          Possible values are : active, archived.

          **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` - Active
                * `archived` - Archived
              enum:
              - active
              - archived
              example: null
            is_not:
              type: string
              description: |-
                * `active` - Active
                * `archived` - Archived
              enum:
              - active
              - archived
              example: null
            in:
              type: string
              description: |-
                * `active` - Active
                * `archived` - Archived
              enum:
              - active
              - archived
              pattern: "^\\[(active|archived)(,(active|archived))*\\]$"
              example: null
            not_in:
              type: string
              description: |-
                * `active` - Active
                * `archived` - Archived
              enum:
              - active
              - archived
              pattern: "^\\[(active|archived)(,(active|archived))*\\]$"
              example: null
      - name: updated_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          Filter product based on their `updated time`
          .
          **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: created_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          Filter product based on their `created time`
          .
          **Supported operators :**
          after, before, on, between

          **Example →**
          *created_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: business_entity_id
        in: query
        description: |
          optional, string filter

          The unique ID of the
          [business entity](/docs/api/business_entities)
          of this `price_variant`.
          [Learn more](/docs/api/using_business_entity_filters_in_product_catalog_list_apis)
          about all the scenarios before using this filter.

          **Supported operators :**
          is, is_present

          **Example →**
          *business_entity_id\[is_present\] = "true"*
        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
            is_present:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
      - name: include_site_level_resources
        in: query
        description: |
          optional, boolean filter

          Default value is `true` . To exclude site-level resources in [specific cases](), set this parameter to `false`.
          Possible values are : *true, false*

          **Supported operators :**
          is

          **Example →**
          *include_site_level_resources\[is\] = "null"*
        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
      - name: sort_by
        in: query
        description: |
          optional, string filter

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

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

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

          This will sort the result based on the 'name' attribute in ascending(earliest first) order.
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
          properties:
            asc:
              type: string
              enum:
              - name
              - id
              - status
              - created_at
              - updated_at
              example: null
            desc:
              type: string
              enum:
              - name
              - id
              - status
              - 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:
                        price_variant:
                          $ref: "#/components/schemas/PriceVariant"
                          description: Resource object representing price_variant
                      required:
                      - price_variant
                      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:
      tags:
      - price_variants
      summary: Create a price variant
      description: |
        This endpoint allows the creation of a new price variant that can be attached to [item prices](/docs/api/item_prices).
      operationId: create_a_price_variant
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                id:
                  type: string
                  deprecated: false
                  description: |
                    The unique and immutable identifier of the price variant.
                  maxLength: 100
                  example: null
                name:
                  type: string
                  deprecated: false
                  description: |
                    A unique name of the price variant.
                  maxLength: 100
                  example: null
                external_name:
                  type: string
                  deprecated: false
                  description: |
                    A unique display name for the price variant.
                  maxLength: 100
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    Description of the price variant.
                  maxLength: 500
                  example: null
                variant_group:
                  type: string
                  deprecated: false
                  description: |
                    The `variant_group`
                    organizes similar [price_variants](/docs/api/price_variants)
                    to optimize strategies such as bundling, geo-based pricing experiments, and campaign-specific pricing like `cb-atomic-pricing-`
                    for effective grouping. The `variant_group`
                    provides greater flexibility and precision in your pricing models.
                  maxLength: 100
                  example: null
                business_entity_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [business entity](/docs/api/business_entities)\n\
                    for this `price_variant`.\nThis is applicable only when multiple\
                    \ business entities have been created for the site. When provided,\
                    \ the operation will read or write data associated with the specified\
                    \ business entity. If not provided, the resource will be created\
                    \ at the site level, and the `business_entity_id`\nwill not be\
                    \ included in the API response.  \n**Note**\nAn alternative way\
                    \ of passing this parameter is by means of a [custom HTTP header](/docs/api/advanced-features#mbe-header-main).\n"
                  maxLength: 50
                  example: null
                attributes:
                  type: object
                  deprecated: false
                  description: |
                    The list of price variant attribute values.
                    Attributes can be used to store additional information about the price variant. For example, for a price variant called 'Germany', the attributes can be 'Country':'Germany', 'City':'Berlin' and so on.
                  properties:
                    name:
                      type: array
                      description: |
                        Attribute name
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    value:
                      type: array
                      description: |
                        Attribute value
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                  required:
                  - name
                  - value
                  example: null
              required:
              - id
              - name
              example: null
            encoding:
              attributes:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  price_variant:
                    $ref: "#/components/schemas/PriceVariant"
                    description: |
                      Resource object representing price_variant
                required:
                - price_variant
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /price_variants/{price-variant-id}:
    get:
      tags:
      - price_variants
      summary: Retrieve a price variant
      description: |
        This endpoint retrieves the details of a specific price variant using its unique identifier.
      operationId: retrieve_a_price_variant
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: price-variant-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/price-variant-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  price_variant:
                    $ref: "#/components/schemas/PriceVariant"
                    description: |
                      Resource object representing price_variant
                required:
                - price_variant
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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:
      tags:
      - price_variants
      summary: Update a price variant
      description: |
        This endpoint modifies the details of an existing price variant.
      operationId: update_a_price_variant
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: price-variant-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/price-variant-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 unique name of the price variant.
                  maxLength: 100
                  example: null
                external_name:
                  type: string
                  deprecated: false
                  description: |
                    A unique display name for the price variant.
                  maxLength: 100
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    Description of the price variant.
                  maxLength: 500
                  example: null
                variant_group:
                  type: string
                  deprecated: false
                  description: |
                    The `variant_group`
                    organizes similar [price_variants](/docs/api/price_variants)
                    to optimize strategies such as bundling, geo-based pricing experiments, and campaign-specific pricing like `cb-atomic-pricing-`
                    for effective grouping. The `variant_group`
                    provides greater flexibility and precision in your pricing models.
                  maxLength: 100
                  example: null
                status:
                  type: string
                  deprecated: false
                  description: |
                    Status of a price variant.

                    * active -
                      Active price variant. This price variant can be attached to [item prices](/docs/api/item_prices)
                      .
                    * archived -
                      Archived price variant. This price variant is no longer `active`
                      and cannot be attached to new [item prices](/docs/api/item_prices).
                      Existing item prices that already have this price variant attached will continue to remain as is.
                  enum:
                  - active
                  - archived
                  example: null
                attributes:
                  type: object
                  deprecated: false
                  description: |
                    The list of price variant attribute values.
                    Attributes can be used to store additional information about the price variant. For example, for a price variant called 'Germany', the attributes can be 'Country':'Germany', 'City':'Berlin' and so on.
                  properties:
                    name:
                      type: array
                      description: |
                        Attribute name
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    value:
                      type: array
                      description: |
                        Attribute value
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                  required:
                  - name
                  - value
                  example: null
              example: null
            encoding:
              attributes:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  price_variant:
                    $ref: "#/components/schemas/PriceVariant"
                    description: |
                      Resource object representing price_variant
                required:
                - price_variant
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /item_prices/{item-price-id}:
    get:
      tags:
      - item_prices
      summary: Retrieve an item price
      description: |
        This API retrieves a specific item price using the id.
      operationId: retrieve_an_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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: item-price-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/item-price-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  item_price:
                    $ref: "#/components/schemas/ItemPrice"
                    description: |
                      Resource object representing item_price
                required:
                - 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:
      tags:
      - item_prices
      summary: Update an item price
      description: |
        Updates an item price with the changes specified. Unspecified item price attributes are not modified.
      operationId: update_an_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: item-price-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/item-price-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: |
                    A unique display name for the item price in the Chargebee UI. If `external_name`
                    is not provided, this is also used in customer-facing pages and documents such as [invoices](/docs/api/invoices)
                    and [hosted pages](/docs/api/hosted_pages)
                    .
                  maxLength: 100
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: "Description of the item price.  \n**Note**:\n\n* The\
                    \ description field supports up to 2000 characters, including\
                    \ HTML tags. The inner text (excluding HTML tags) must not exceed\
                    \ 500 characters. For example: `- testing - desc `. Total with\
                    \ tags: 38 characters, inner text: 'testing desc' (12 characters).\n\
                    * If your input includes characters requiring sanitization, such\
                    \ as incomplete HTML tags, the sanitization process may alter\
                    \ the input and increase its length. If the sanitized content\
                    \ exceeds the allowed limit, the request will be rejected.\n"
                  maxLength: 2000
                  example: null
                proration_type:
                  type: string
                  deprecated: false
                  description: |
                    **Note**
                    Applicable only for item prices with:

                    * [item_type](/docs/api/item_prices/item_price-object#item_type) = `addon`.
                    * [pricing_model](/docs/api/item_prices/item_price-object#pricing_model) = `per_unit`.

                    Specifies how to manage charges or credits for the addon item price during a [subscription update](/docs/api/subscriptions/update-subscription-for-items)
                    or [estimating](/docs/api/estimates/estimate-for-updating-a-subscription)
                    a subscription update.

                    * full_term - Charge the full price of the addon item price or give the full credit. Don't apply any proration.
                    * site_default -
                      Use the [site-wide proration setting](https://www.chargebee.com/docs/2.0/proration.html#proration-for-subscription-change)
                      .
                    * partial_term - Prorate the charges or credits for the rest of the current term.
                  enum:
                  - site_default
                  - partial_term
                  - full_term
                  example: null
                price_variant_id:
                  type: string
                  deprecated: false
                  description: |
                    An immutable unique identifier of a [price variant](/docs/api/price_variants).
                  maxLength: 100
                  example: null
                status:
                  type: string
                  deprecated: false
                  description: |
                    The status of the item price.

                    * archived - 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.
                    * active - The item price can be used in subscriptions.
                  enum:
                  - active
                  - archived
                  example: null
                external_name:
                  type: string
                  deprecated: false
                  description: |
                    The name of the item price used in customer-facing pages and documents. These include [invoices](/docs/api/invoices)
                    and [hosted pages](/docs/api/hosted_pages).
                    If not provided, then `name`
                    is used.
                  maxLength: 100
                  example: null
                usage_accumulation_reset_frequency:
                  type: string
                  deprecated: false
                  description: "Specifies the frequency at which the usage counter\
                    \ needs to be reset.  \n**Note:**\nChanges to the `usage_accumulation_reset_frequency`\n\
                    parameter for `item_price`\nis not allowed if the `item`\nis already\
                    \ linked to a subscription.\n\n.\n\n* never - Accumulates usage\
                    \ without ever resetting it.\n* subscription_billing_frequency\
                    \ - Accumulates usage until the subscription's billing frequency\
                    \ ends.\n"
                  enum:
                  - never
                  - subscription_billing_frequency
                  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)
                    ) for the item price. If subscriptions, invoices or [differential prices](/docs/api/differential_prices)
                    exist for this item price, `currency_code`
                    cannot be changed.
                  maxLength: 3
                  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
                is_taxable:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |
                    Specifies whether taxes apply to this item price. 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
                free_quantity:
                  type: integer
                  format: int32
                  default: 0
                  deprecated: false
                  description: "Free quantity the subscriptions of this **plan** `item_price`\
                    \ will have. Only the quantity exceeding this value will be charged\
                    \ in the subscription.  \n**Note:**\n\n* `free_quantity` is currently\
                    \ supported only for [plan](/docs/api/items/item-object#type)\
                    \ `item_price`.\n* `free_quantity` is not supported for the [Usage-Based\
                    \ Billing](https://www.chargebee.com/docs/2.0/understanding-usages.html)\
                    \ (UBB). All included or free quantities should be configured\
                    \ exclusively through [entitlements](/docs/api/entitlements) .\n"
                  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/currencies)
                    is enabled.
                  maxLength: 33
                  example: null
                metadata:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: "A collection of key-value pairs that provides extra\
                    \ information about the item price.  \n**Note:**\nThere's a character\
                    \ limit of 65,535.\n\n[Learn more](/docs/api/advanced-features#metadata)\n\
                    .\n"
                  example: null
                pricing_model:
                  type: string
                  default: flat_fee
                  deprecated: false
                  description: |
                    The [pricing scheme](https://www.chargebee.com/docs/2.0/plans.html#pricing-models) for this item price. If subscriptions, invoices or [differential prices](/docs/api/differential_prices) exist for this item price, `pricing_model` cannot be changed.

                    * 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
                price:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    The cost of the item price when the pricing model is `flat_fee`.
                    When the pricing model is `per_unit`
                    , it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in the [minor unit of the currency](/docs/api/currencies)
                    .
                  minimum: 0
                  example: null
                price_in_decimal:
                  type: string
                  deprecated: false
                  description: |
                    The price of the item when the pricing_model is `flat_fee`.
                    When the pricing model is `per_unit`
                    , 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 [multi-decimal pricing](/docs/api/currencies)
                    is enabled.
                  maxLength: 39
                  example: null
                period_unit:
                  type: string
                  deprecated: false
                  description: "The unit of time for `period`.\nIf subscriptions or\
                    \ invoices exist for this item price, `period_unit`\ncannot be\
                    \ changed. The `period_unit`\nis mandatory when the item `type`\n\
                    is `plan`\nor `addon`\n.  \n**Important:**\nThe `period` + `period_unit`\
                    \ pair must match a *configured billing frequency* on your site.\
                    \ The API does not create new frequencies. To use a new frequency\
                    \ (for example, 3 months or 2 weeks), add it in the site settings\
                    \ first. Requests with non-configured combinations fail validation.\n\
                    \n* Monthly: `period=1`, `period_unit=month` (available by default)\n\
                    * Quarterly: `period=3`, `period_unit=month` (*enable 3-month\
                    \ frequency in settings*)\n* Weekly: `period=1`, `period_unit=week`\
                    \ (available by default) See [how billing periods apply](https://www.chargebee.com/docs/billing/2.0/subscriptions/addons-billingcycle)\
                    \ .\n\n* month - A period of 1 calendar month.\n* week - A period\
                    \ of 7 days.\n* year - A period of 1 calendar year.\n* day - A\
                    \ period of 24 hours.\n"
                  enum:
                  - day
                  - week
                  - month
                  - year
                  example: null
                period:
                  type: integer
                  format: int32
                  deprecated: false
                  description: "* When the item `type` is `plan`: The billing period\
                    \ of the plan in `period_unit`s. For example, create a 6 month\
                    \ plan by providing `period` as 6 and `period_unit` as month.\n\
                    * When item `type` is `addon`: The period of the addon in `period_unit`s.\
                    \ For example, create an addon with a 2 month `period` by providing\
                    \ period as 2 and `period_unit` as `month`. The period of an addon\
                    \ is the duration for which its `price` applies. When attached\
                    \ to a plan, the addon is billed for the billing period of the\
                    \ plan. [Learn more.](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)\n\
                    \nIf subscriptions or invoices exist for this item price, `period`\n\
                    cannot be changed. The `period`\nis mandatory when the item `type`\n\
                    is `plan`\nor `addon`.  \n**Important:**\nThe `period` value,\
                    \ together with `period_unit`, must equal one of your site's *configured\
                    \ billing frequencies* . If the combination does not exist, the\
                    \ request fails with an invalid billing period configuration error.\
                    \ Configure the frequency in site settings and retry. See [Addons\
                    \ and billing cycle](https://www.chargebee.com/docs/billing/2.0/subscriptions/addons-billingcycle).\n"
                  minimum: 1
                  example: null
                trial_period_unit:
                  type: string
                  deprecated: false
                  description: |
                    The unit of time for `trial_period`
                    .

                    * month - A period of 1 calendar month.
                    * day - A period of 24 hours.
                  enum:
                  - day
                  - month
                  example: null
                trial_period:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The trial period of the plan in `trial_period_unit`
                    s. You can also set [trial periods for addons](https://www.chargebee.com/docs/2.0/addons-trial.html)
                    ; 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 enable that feature.
                  minimum: 0
                  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.

                    * day - A period of 24 hours.
                    * week - A period of 7 days.
                    * year - A period of 1 calendar year.
                    * month - A period of 1 calendar month.
                  enum:
                  - day
                  - week
                  - month
                  - year
                  example: null
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: "The default number of billing cycles a subscription\
                    \ to the plan must run. Can be [overridden](/docs/api/subscriptions)\
                    \ for a subscription.\nAddons can also [have billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html).\
                    \ Also, for addons, you can [override this](/docs/api/attached_items)\
                    \ while attaching it to a plan. However, if you provide the value\
                    \ while [applying the addon to a subscription](/docs/api/subscriptions/subscription-object#subscription_items_item_type),\
                    \ then that value takes still higher precedence.\nIf subscriptions,\
                    \ invoices or [differential prices](/docs/api/differential_prices)\n\
                    exist for this item price, `billing_cycles`\ncannot be changed.\
                    \  \n**Note:**\nIf you want to change the `billing_cycles`\nto\
                    \ unlimited renewals, enter an empty string. This value can only\
                    \ be updated if the `item_price`\nis not attached to a subscription\
                    \ or invoice. If no `billing_cycles`\nvalue is entered, then by\
                    \ default the value will be set as unlimited `billing_cycles`\n\
                    renewals.\n"
                  minimum: 1
                  example: null
                trial_end_action:
                  type: string
                  deprecated: false
                  description: |
                    Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/2.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
                    has been enabled for the site. Specifies the operation to be carried out for the subscription once the trial ends. Whenever the `item.type`
                    is `plan`
                    and a trial period is defined for this item price, this attribute (parameter) is returned (required). This can be overridden at the [subscription-level](/docs/api/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/2.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
                show_description_in_invoices:
                  type: boolean
                  deprecated: false
                  description: |
                    Whether the item price's description 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
                  deprecated: false
                  description: |
                    Whether the item price's description 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
                tax_detail:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for tax_detail
                  properties:
                    tax_profile_id:
                      type: string
                      deprecated: false
                      description: |
                        The tax profile of the item price.
                      maxLength: 50
                      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
                    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)
                        .

                        * 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
                        * 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 [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
                    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
                  example: null
                accounting_detail:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for accounting_detail
                  properties:
                    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: |
                        Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/2.0/finance-integration-index.html )

                        * [**Xero:**](https://www.chargebee.com/docs/2.0/xero.html ) If you've categorized your products in Xero, provide the category name and option. Use the format: `:` . For example:`Location: Singapore.`
                        * [**QuickBooks:**](https://www.chargebee.com/docs/2.0/quickbooks.html ) If you've categorized your product sales in QuickBooks according to Classes, provide the class name here. Use the following format: `::...`
                        * [**NetSuite:**](https://www.chargebee.com/docs/2.0/netsuite.html ) If you've categorized your products in NetSuite under Classes, provide the class name here. Use the following format: `: : ....` For example: `Services: Plan.`
                        * [**Intacct:**](https://www.chargebee.com/docs/2.0/intacct.html ) If you've classified your products in Intacct under Locations, provide the name of the Location here.
                      maxLength: 100
                      example: null
                    accounting_category2:
                      type: string
                      deprecated: false
                      description: |
                        Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/2.0/finance-integration-index.html )

                        * [**Xero:**](https://www.chargebee.com/docs/2.0/xero.html ) If you've categorized your products in Xero, then provide the second category name and option here. Use the format: `: ....` For example, `Region: South`
                        * [**QuickBooks:**](https://www.chargebee.com/docs/2.0/quickbooks.html ) If you've categorized your product sales in QuickBooks according to Location, provide the Location name here. Use the following format: `::....` For example: `Location: North America: Canada`
                        * [**NetSuite:**](https://www.chargebee.com/docs/2.0/netsuite.html ) If you've categorized your products in NetSuite under Locations, provide the location name here. Use the following format `: : ....` For example: `NA:US:CA`
                        * [**Intacct:**](https://www.chargebee.com/docs/2.0/intacct.html ) If you've classified your products in Intacct under Dimensions, provide the value of the Dimension here.
                      maxLength: 100
                      example: null
                    accounting_category3:
                      type: string
                      deprecated: false
                      description: |
                        Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/2.0/finance-integration-index.html )

                        * [**NetSuite:**](https://www.chargebee.com/docs/2.0/netsuite.html ) If you've categorized your products in NetSuite under Departments, pass the department name here. Use the following format: `: : ....` For example: `Production: Assembly.`
                        * [**Intacct:**](https://www.chargebee.com/docs/2.0/intacct.html ) If you've classified your products in Intacct under multiple Dimensions, provide the value of the second Dimension here.
                      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
                  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: |
                        The per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`
                        ; the total cost for the item price when the `pricing_model`
                        is `stairstep`.
                        The value is in the [minor unit of the currency](/docs/api/currencies)
                        .
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the `pricing_model`
                        is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the `pricing_model`
                        is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , 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 [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    pricing_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Pricing type for the tier.

                          * flat_fee -
                            Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                            pricing model, `pricing_type`
                            will be set to `flat_fee`
                            by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                          * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                          * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20, consuming 400 units will result in a charge of $80 (4 × $20).
                        enum:
                        - per_unit
                        - flat_fee
                        - package
                        example: null
                      example: null
                    package_size:
                      type: array
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        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:
              accounting_detail:
                style: deepObject
                explode: true
              tax_detail:
                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:
                  item_price:
                    $ref: "#/components/schemas/ItemPrice"
                    description: |
                      Resource object representing item_price
                required:
                - 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: []
  /item_prices/{item-price-id}/delete:
    post:
      tags:
      - item_prices
      summary: Delete an item price
      description: |
        Deletes an item price, marking its `status` as `deleted`. If it is part of a subscription or invoice, the item price `status` is marked `archived` instead. Once deleted, the `id` and `name` of the item price can be reused to create a new item price.
      operationId: delete_an_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: item-price-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/item-price-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  item_price:
                    $ref: "#/components/schemas/ItemPrice"
                    description: |
                      Resource object representing item_price
                required:
                - 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: []
  /item_prices/{item-price-id}/applicable_item_prices:
    get:
      tags:
      - item_prices
      summary: List applicable item prices for a plan-item price
      description: |
        Returns the set of all applicable [addon-item](/docs/api/item_prices)
        prices for a specific plan-item price. This set consists of all the addon-item prices that can be applied to a subscription having the plan-item price. When determining this set, Chargebee considers the following:

        * the [item_applicability](/docs/api/items/item-object#item_applicability) and [applicable_items](/docs/api/items/item-object#applicable_items) defined for the parent item of the plan-item price
        * the [compatibility](/docs/api/subscriptions) of the addon-item prices to the plan-item price

        **Note**

        If an addon-item price has [differential pricing](/docs/api/differential_prices) defined against the parent item of the plan-item price, then the pricing information in the addon-item price object returned, reflects the differential pricing.
      operationId: list_applicable_item_prices_for_a_plan-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: item-price-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/item-price-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: item_id
        in: query
        description: |
          The id of the item that the item price belongs to.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          deprecated: false
          maxLength: 100
          example: null
      - name: sort_by
        in: query
        description: |
          optional, string filter

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

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

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

          This will sort the result based on the 'name' attribute in ascending(earliest first) order.
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
          properties:
            asc:
              type: string
              enum:
              - name
              - id
              - updated_at
              example: null
            desc:
              type: string
              enum:
              - name
              - id
              - updated_at
              example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        item_price:
                          $ref: "#/components/schemas/ItemPrice"
                          description: Resource object representing item_price
                      required:
                      - 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: []
  /item_prices/{item-price-id}/applicable_items:
    get:
      tags:
      - item_prices
      summary: List applicable items for a plan-item price
      description: |
        Returns the set of all applicable [addon-items](/docs/api/items)
        for a specific [plan-item price](/docs/api/item_prices)
        . This set consists of all addon-items whose item prices can be applied to a subscription having the plan-item price in it. When determining this set, Chargebee considers the [item_applicability](/docs/api/items/item-object#item_applicability)
        and [applicable_items](/docs/api/items/item-object#applicable_items)
        defined for the parent item of the plan-item price.
      operationId: list_applicable_items_for_a_plan-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: item-price-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/item-price-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: sort_by
        in: query
        description: |
          optional, string filter

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

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

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

          This will sort the result based on the 'name' attribute in ascending(earliest first) order.
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
          properties:
            asc:
              type: string
              enum:
              - name
              - id
              - updated_at
              example: null
            desc:
              type: string
              enum:
              - name
              - id
              - updated_at
              example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        item:
                          $ref: "#/components/schemas/Item"
                          description: Resource object representing item
                      required:
                      - 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: []
  /item_prices:
    get:
      tags:
      - item_prices
      summary: List item prices
      description: "Returns a list of item prices satisfying **all** the conditions\
        \ specified in the filter parameters below. The list is sorted by the date\
        \ of creation in descending order.  \n\n### Use Cases\n\n##### Filter by custom\
        \ fields\n\n**Note:** Custom field filters are turned off by default. To turn\
        \ them on for your site, 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\
        \nYou can filter the response by [custom fields](/docs/api/advanced-features#filtering-by-custom-field-values)\
        \ configured on item prices. After they're turned on for your site, the filter\
        \ parameters are visible on this page when you're logged in. For the supported\
        \ operators and limits, see [Filtering by custom field values](/docs/api/advanced-features#filtering-by-custom-field-values).\n\
        \nItem prices inherit the type of their parent item (`plan`, `addon`, or `charge`),\
        \ and each type can have its own custom fields. As a result, the filter parameter\
        \ is scoped per item price type rather than shared across item prices.\n\n\
        Use one of the following forms, where `cf_CUSTOM_FIELD_NAME` is the exact,\
        \ case-sensitive API name of a custom field configured on the corresponding\
        \ item price type:\n\n```bg-gray-100 text-gray-800 font-medium border border-gray-300\
        \ rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\nplan_price[cf_CUSTOM_FIELD_NAME][OPERATOR]=VALUE\n\
        addon_price[cf_CUSTOM_FIELD_NAME][OPERATOR]=VALUE\ncharge_price[cf_CUSTOM_FIELD_NAME][OPERATOR]=VALUE\n\
        ```\n\nFor example, to filter plan item prices by the custom field `cf_region`,\
        \ pass it as a query parameter:\n\n```bash\ncurl https://{site}.chargebee.com/api/v2/item_prices\
        \ \\\n    -G -u {site_api_key}: \\\n    -d plan_price[cf_region][is]=\"APAC\"\
        \n```\n\n"
      operationId: list_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: id
        in: query
        description: |
          optional, string filter

          Filter item prices based on their [id](/docs/api/item_prices)
          .
          **Supported operators :**
          is, is_not, starts_with, in, not_in

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

          Filter item prices based on their `name`
          s.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

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

          Filter item prices based on their `pricing_model`.
          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: item_id
        in: query
        description: |
          optional, string filter

          Filter item prices based on their `item_id`
          .
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *item_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: item_family_id
        in: query
        description: |
          optional, string filter

          Filter item prices based on `item_family_id`
          .
          **Supported operators :**
          is, is_not, starts_with, in, not_in

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

          Filter item prices based on `item_type`.
          Possible values are : plan, addon, charge.

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

          **Example →**
          *item_type\[is_not\] = "plan"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: plan
          properties:
            is:
              type: string
              description: |
                * `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.
                * `addon` - A recurring component that can be added to a subscription in addition to its plan.
                * `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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.
              enum:
              - plan
              - addon
              - charge
              example: null
            is_not:
              type: string
              description: |
                * `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.
                * `addon` - A recurring component that can be added to a subscription in addition to its plan.
                * `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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.
              enum:
              - plan
              - addon
              - charge
              example: null
            in:
              type: string
              description: |
                * `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.
                * `addon` - A recurring component that can be added to a subscription in addition to its plan.
                * `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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.
              enum:
              - plan
              - addon
              - charge
              pattern: "^\\[(plan|addon|charge)(,(plan|addon|charge))*\\]$"
              example: null
            not_in:
              type: string
              description: |
                * `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.
                * `addon` - A recurring component that can be added to a subscription in addition to its plan.
                * `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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.
              enum:
              - plan
              - addon
              - charge
              pattern: "^\\[(plan|addon|charge)(,(plan|addon|charge))*\\]$"
              example: null
      - name: currency_code
        in: query
        description: |
          optional, string filter

          Filter item prices based on their `currency_code`
          .
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *currency_code\[is_not\] = "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: price_variant_id
        in: query
        description: |
          optional, string filter

          Filter item prices based on their `price_variant_id`
          .
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *price_variant_id\[is\] = "tamilNadu-India"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: tamilNadu-India
          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: trial_period
        in: query
        description: |
          optional, integer filter

          Filter item prices based on their `trial_period`
          .
          **Supported operators :**
          is, is_not, lt, lte, gt, gte, between

          **Example →**
          *trial_period\[is\] = "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
      - name: trial_period_unit
        in: query
        description: |
          optional, enumerated string filter

          Filter item prices based on their `trial_period_unit`.
          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` - A period of 24 hours.
                * `month` - A period of 1 calendar month.
              enum:
              - day
              - month
              example: null
            is_not:
              type: string
              description: |-
                * `day` - A period of 24 hours.
                * `month` - A period of 1 calendar month.
              enum:
              - day
              - month
              example: null
            in:
              type: string
              description: |-
                * `day` - A period of 24 hours.
                * `month` - A period of 1 calendar month.
              enum:
              - day
              - month
              pattern: "^\\[(day|month)(,(day|month))*\\]$"
              example: null
            not_in:
              type: string
              description: |-
                * `day` - A period of 24 hours.
                * `month` - A period of 1 calendar month.
              enum:
              - day
              - month
              pattern: "^\\[(day|month)(,(day|month))*\\]$"
              example: null
      - name: status
        in: query
        description: |
          optional, enumerated string filter

          Filter item prices based on their `status`.
          Possible values are : active, archived.

          **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` - The item price can be used in subscriptions.
                * `archived` - 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.
                * `deleted` - Indicates that the item price has been deleted. The `id` and `name` can be reused.
              enum:
              - active
              - archived
              - deleted
              example: null
            is_not:
              type: string
              description: |
                * `active` - The item price can be used in subscriptions.
                * `archived` - 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.
                * `deleted` - Indicates that the item price has been deleted. The `id` and `name` can be reused.
              enum:
              - active
              - archived
              - deleted
              example: null
            in:
              type: string
              description: |
                * `active` - The item price can be used in subscriptions.
                * `archived` - 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.
                * `deleted` - Indicates that the item price has been deleted. The `id` and `name` can be reused.
              enum:
              - active
              - archived
              - deleted
              pattern: "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                * `active` - The item price can be used in subscriptions.
                * `archived` - 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.
                * `deleted` - Indicates that the item price has been deleted. The `id` and `name` can be reused.
              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

          Filter item prices based on their `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: business_entity_id
        in: query
        description: |
          optional, string filter

          The unique ID of the
          [business entity](/docs/api/business_entities)
          of this `item_price`.
          [Learn more](/docs/api/using_business_entity_filters_in_product_catalog_list_apis)
          about all the scenarios before using this filter.

          **Supported operators :**
          is, is_present

          **Example →**
          *business_entity_id\[is_present\] = "true"*
        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
            is_present:
              type: string
              format: boolean
              enum:
              - "true"
              - "false"
              example: null
      - name: include_site_level_resources
        in: query
        description: |
          optional, boolean filter

          Default value is `true` . To exclude site-level resources in [specific cases](), set this parameter to `false`.
          Possible values are : *true, false*

          **Supported operators :**
          is

          **Example →**
          *include_site_level_resources\[is\] = "null"*
        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
      - name: period_unit
        in: query
        description: |
          optional, enumerated string filter

          Filter item prices based on their `period_unit`.
          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` - A period of 24 hours.
                * `week` - A period of 7 days.
                * `month` - A period of 1 calendar month.
                * `year` - A period of 1 calendar year.
              enum:
              - day
              - week
              - month
              - year
              example: null
            is_not:
              type: string
              description: |-
                * `day` - A period of 24 hours.
                * `week` - A period of 7 days.
                * `month` - A period of 1 calendar month.
                * `year` - A period of 1 calendar year.
              enum:
              - day
              - week
              - month
              - year
              example: null
            in:
              type: string
              description: |-
                * `day` - A period of 24 hours.
                * `week` - A period of 7 days.
                * `month` - A period of 1 calendar month.
                * `year` - A period of 1 calendar year.
              enum:
              - day
              - week
              - month
              - year
              pattern: "^\\[(day|week|month|year)(,(day|week|month|year))*\\]$"
              example: null
            not_in:
              type: string
              description: |-
                * `day` - A period of 24 hours.
                * `week` - A period of 7 days.
                * `month` - A period of 1 calendar month.
                * `year` - A period of 1 calendar year.
              enum:
              - day
              - week
              - month
              - year
              pattern: "^\\[(day|week|month|year)(,(day|week|month|year))*\\]$"
              example: null
      - name: period
        in: query
        description: |
          optional, integer filter

          Filter item prices based on their `period`
          .
          **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: 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.\n* `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.\n* `play_store` -\n  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.  \n  In-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.\n* `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.\n* `play_store` -\n  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.  \n  In-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.\n* `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.\n* `play_store` -\n  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.  \n  In-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.\n* `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.\n* `play_store` -\n  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.  \n  In-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: sort_by
        in: query
        description: |
          optional, string filter

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

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

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

          This will sort the result based on the 'name' attribute in ascending(earliest first) order.
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
          properties:
            asc:
              type: string
              enum:
              - name
              - id
              - updated_at
              example: null
            desc:
              type: string
              enum:
              - name
              - id
              - updated_at
              example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        item_price:
                          $ref: "#/components/schemas/ItemPrice"
                          description: Resource object representing item_price
                      required:
                      - 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: []
    post:
      tags:
      - item_prices
      summary: Create an item price
      description: |
        This API creates an item price (a price point) for an [item](/docs/api/items).
      operationId: create_an_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
              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: |
                    A unique display name for the item price in the Chargebee UI. If `external_name`
                    is not provided, this is also used in customer-facing pages and documents such as [invoices](/docs/api/invoices)
                    and [hosted pages](/docs/api/hosted_pages)
                    .
                  maxLength: 100
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    Description of the item price.
                  maxLength: 2000
                  example: null
                item_id:
                  type: string
                  deprecated: false
                  description: |
                    The id of the item that the item price belongs to.
                  maxLength: 100
                  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
                proration_type:
                  type: string
                  deprecated: false
                  description: |
                    Specifies how to manage charges or credits for the addon item price during a [subscription update](/docs/api/subscriptions/update-subscription-for-items)
                    or [estimating](/docs/api/estimates/estimate-for-updating-a-subscription)
                    a subscription update.

                    * full_term - Charge the full price of the addon item price or give the full credit. Don't apply any proration.
                    * site_default -
                      Use the [site-wide proration setting](https://www.chargebee.com/docs/2.0/proration.html#proration-for-subscription-change)
                      .
                    * partial_term - Prorate the charges or credits for the rest of the current term.
                  enum:
                  - site_default
                  - partial_term
                  - full_term
                  example: null
                external_name:
                  type: string
                  deprecated: false
                  description: |
                    The name of the item price used in customer-facing pages and documents. These include [invoices](/docs/api/invoices)
                    and [hosted pages](/docs/api/hosted_pages).
                    If not provided, then `name`
                    is used.
                  maxLength: 100
                  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 item price. Is required when multiple currencies have been enabled.
                  maxLength: 3
                  example: null
                price_variant_id:
                  type: string
                  deprecated: false
                  description: |
                    An immutable unique identifier of a [price variant](/docs/api/price_variants).
                  maxLength: 100
                  example: null
                is_taxable:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |
                    Specifies whether taxes apply to this item price. 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
                free_quantity:
                  type: integer
                  format: int32
                  default: 0
                  deprecated: false
                  description: "Free quantity the subscriptions of this **plan** `item_price`\
                    \ will have. Only the quantity exceeding this value will be charged\
                    \ in the subscription.  \n**Note:**\n\n* `free_quantity` is currently\
                    \ supported only for [plan](/docs/api/items/item-object#type)\
                    \ `item_price`.\n* `free_quantity` is not supported for the [Usage-Based\
                    \ Billing](https://www.chargebee.com/docs/2.0/understanding-usages.html)\
                    \ (UBB). All included or free quantities should be configured\
                    \ exclusively through [entitlements](/docs/api/entitlements) .\n"
                  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
                metadata:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: "A collection of key-value pairs that provides extra\
                    \ information about the item price.  \n**Note:**\nThere's a character\
                    \ limit of 65,535.\n\n[Learn more](/docs/api/advanced-features#metadata)\n\
                    .\n"
                  example: null
                show_description_in_invoices:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    Whether the item price's description 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 item price's description 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
                usage_accumulation_reset_frequency:
                  type: string
                  deprecated: false
                  description: "Specifies the frequency at which the usage counter\
                    \ needs to be reset.  \n**Note:**\nChanges to the `usage_accumulation_reset_frequency`\n\
                    parameter for `item_price`\nis not allowed if the `item`\nis already\
                    \ linked to a subscription.\n\n.\n\n* never - Accumulates usage\
                    \ without ever resetting it.\n* subscription_billing_frequency\
                    \ - Accumulates usage until the subscription's billing frequency\
                    \ ends.\n"
                  enum:
                  - never
                  - subscription_billing_frequency
                  example: null
                business_entity_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [business entity](/docs/api/business_entities)\n\
                    for this `item_price`.\nThis is applicable only when multiple\
                    \ business entities have been created for the site. When provided,\
                    \ the operation will read or write data associated with the specified\
                    \ business entity. If not provided, the resource will be created\
                    \ at the site level, and the `business_entity_id`\nwill not be\
                    \ included in the API response.  \n**Note**\nAn alternative way\
                    \ of passing this parameter is by means of a [custom HTTP header](/docs/api/advanced-features#mbe-header-main).\n"
                  maxLength: 50
                  example: null
                pricing_model:
                  type: string
                  default: flat_fee
                  deprecated: false
                  description: |
                    The [pricing scheme](https://www.chargebee.com/docs/2.0/plans.html#pricing-models) for this item price. If subscriptions, invoices or [differential prices](/docs/api/differential_prices) exist for this item price, `pricing_model` cannot be changed.

                    * 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
                price:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    The cost of the item price when the pricing model is `flat_fee`.
                    When the pricing model is `per_unit`
                    , it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in the [minor unit of the currency](/docs/api/getting-started)
                    .
                  minimum: 0
                  example: null
                price_in_decimal:
                  type: string
                  deprecated: false
                  description: |
                    The price of the item when the pricing_model is `flat_fee`.
                    When the pricing model is `per_unit`
                    , 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 [multi-decimal pricing](/docs/api/getting-started)
                    is enabled.
                  maxLength: 39
                  example: null
                period_unit:
                  type: string
                  deprecated: false
                  description: "The unit of time for `period`.\nIf subscriptions or\
                    \ invoices exist for this item price, `period_unit`\ncannot be\
                    \ changed. The `period_unit`\nis mandatory when the item `type`\n\
                    is `plan`\nor `addon`\n.  \n**Important:**\nThe `period` + `period_unit`\
                    \ pair must match a *configured billing frequency* on your site.\
                    \ The API does not create new frequencies. To use a new frequency\
                    \ (for example, 3 months or 2 weeks), add it in the site settings\
                    \ first. Requests with non-configured combinations fail validation.\n\
                    \n* Monthly: `period=1`, `period_unit=month` (available by default)\n\
                    * Quarterly: `period=3`, `period_unit=month` (*enable 3-month\
                    \ frequency in settings*)\n* Weekly: `period=1`, `period_unit=week`\
                    \ (available by default) See [how billing periods apply](https://www.chargebee.com/docs/billing/2.0/subscriptions/addons-billingcycle)\
                    \ .\n\n* month - A period of 1 calendar month.\n* week - A period\
                    \ of 7 days.\n* year - A period of 1 calendar year.\n* day - A\
                    \ period of 24 hours.\n"
                  enum:
                  - day
                  - week
                  - month
                  - year
                  example: null
                period:
                  type: integer
                  format: int32
                  deprecated: false
                  description: "* When the item `type` is `plan`: The billing period\
                    \ of the plan in `period_unit`s. For example, create a 6 month\
                    \ plan by providing `period` as 6 and `period_unit` as month.\n\
                    * When item `type` is `addon`: The period of the addon in `period_unit`s.\
                    \ For example, create an addon with a 2 month `period` by providing\
                    \ period as 2 and `period_unit` as `month`. The period of an addon\
                    \ is the duration for which its `price` applies. When attached\
                    \ to a plan, the addon is billed for the billing period of the\
                    \ plan. [Learn more.](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)\n\
                    \nIf subscriptions or invoices exist for this item price, `period`\n\
                    cannot be changed. The `period`\nis mandatory when the item `type`\n\
                    is `plan`\nor `addon`.  \n**Important:**\nThe `period` value,\
                    \ together with `period_unit`, must equal one of your site's *configured\
                    \ billing frequencies* . If the combination does not exist, the\
                    \ request fails with an invalid billing period configuration error.\
                    \ Configure the frequency in site settings and retry. See [Addons\
                    \ and billing cycle](https://www.chargebee.com/docs/billing/2.0/subscriptions/addons-billingcycle).\n"
                  minimum: 1
                  example: null
                trial_period_unit:
                  type: string
                  deprecated: false
                  description: |
                    The unit of time for `trial_period`
                    .

                    * month - A period of 1 calendar month.
                    * day - A period of 24 hours.
                  enum:
                  - day
                  - month
                  example: null
                trial_period:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The trial period of the plan in `trial_period_unit`
                    s. You can also set [trial periods for addons](https://www.chargebee.com/docs/2.0/addons-trial.html)
                    ; 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 enable that feature.
                  minimum: 0
                  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.

                    * day - A period of 24 hours.
                    * week - A period of 7 days.
                    * year - A period of 1 calendar year.
                    * month - A period of 1 calendar month.
                  enum:
                  - day
                  - week
                  - month
                  - year
                  example: null
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: "The default number of billing cycles a subscription\
                    \ to the plan must run. Can be [overridden](/docs/api/subscriptions)\
                    \ for a subscription.\nAddons can also [have billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html).\
                    \ Also, for addons, you can [override this](/docs/api/attached_items)\
                    \ while attaching it to a plan. However, if you provide the value\
                    \ while [applying the addon to a subscription](/docs/api/subscriptions/subscription-object#subscription_items_item_type),\
                    \ then that value takes still higher precedence.\nIf subscriptions,\
                    \ invoices or [differential prices](/docs/api/differential_prices)\n\
                    exist for this item price, `billing_cycles`\ncannot be changed.\
                    \  \n**Note:**\nIf you want to change the `billing_cycles`\nto\
                    \ unlimited renewals, enter an empty string. This value can only\
                    \ be updated if the `item_price`\nis not attached to a subscription\
                    \ or invoice. If no `billing_cycles`\nvalue is entered, then by\
                    \ default the value will be set as unlimited `billing_cycles`\n\
                    renewals.\n"
                  minimum: 1
                  example: null
                trial_end_action:
                  type: string
                  deprecated: false
                  description: |
                    Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/2.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
                    has been enabled for the site. Specifies the operation to be carried out for the subscription once the trial ends. Whenever the `item.type`
                    is `plan`
                    and a trial period is defined for this item price, this attribute (parameter) is returned (required). This can be overridden at the [subscription-level](/docs/api/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/2.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
                tax_detail:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for tax_detail
                  properties:
                    tax_profile_id:
                      type: string
                      deprecated: false
                      description: |
                        The tax profile of the item price.
                      maxLength: 50
                      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
                    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)
                        .

                        * 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
                        * 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 [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
                    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
                  example: null
                accounting_detail:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for accounting_detail
                  properties:
                    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: |
                        Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/2.0/finance-integration-index.html )

                        * [**Xero:**](https://www.chargebee.com/docs/2.0/xero.html ) If you've categorized your products in Xero, provide the category name and option. Use the format: `:` . For example:`Location: Singapore.`
                        * [**QuickBooks:**](https://www.chargebee.com/docs/2.0/quickbooks.html ) If you've categorized your product sales in QuickBooks according to Classes, provide the class name here. Use the following format: `::...`
                        * [**NetSuite:**](https://www.chargebee.com/docs/2.0/netsuite.html ) If you've categorized your products in NetSuite under Classes, provide the class name here. Use the following format: `: : ....` For example: `Services: Plan.`
                        * [**Intacct:**](https://www.chargebee.com/docs/2.0/intacct.html ) If you've classified your products in Intacct under Locations, provide the name of the Location here.
                      maxLength: 100
                      example: null
                    accounting_category2:
                      type: string
                      deprecated: false
                      description: |
                        Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/2.0/finance-integration-index.html )

                        * [**Xero:**](https://www.chargebee.com/docs/2.0/xero.html ) If you've categorized your products in Xero, then provide the second category name and option here. Use the format: `: ....` For example, `Region: South`
                        * [**QuickBooks:**](https://www.chargebee.com/docs/2.0/quickbooks.html ) If you've categorized your product sales in QuickBooks according to Location, provide the Location name here. Use the following format: `::....` For example: `Location: North America: Canada`
                        * [**NetSuite:**](https://www.chargebee.com/docs/2.0/netsuite.html ) If you've categorized your products in NetSuite under Locations, provide the location name here. Use the following format `: : ....` For example: `NA:US:CA`
                        * [**Intacct:**](https://www.chargebee.com/docs/2.0/intacct.html ) If you've classified your products in Intacct under Dimensions, provide the value of the Dimension here.
                      maxLength: 100
                      example: null
                    accounting_category3:
                      type: string
                      deprecated: false
                      description: |
                        Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/2.0/finance-integration-index.html )

                        * [**NetSuite:**](https://www.chargebee.com/docs/2.0/netsuite.html ) If you've categorized your products in NetSuite under Departments, pass the department name here. Use the following format: `: : ....` For example: `Production: Assembly.`
                        * [**Intacct:**](https://www.chargebee.com/docs/2.0/intacct.html ) If you've classified your products in Intacct under multiple Dimensions, provide the value of the second Dimension here.
                      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
                  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: |
                        The per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`
                        ; the total cost for the item price when the `pricing_model`
                        is `stairstep`.
                        The value is in the [minor unit of the currency](/docs/api/getting-started)
                        .
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the `pricing_model`
                        is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the `pricing_model`
                        is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , 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 [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    pricing_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Pricing type for the tier.

                          * flat_fee -
                            Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                            pricing model, `pricing_type`
                            will be set to `flat_fee`
                            by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                          * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                          * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20, consuming 400 units will result in a charge of $80 (4 × $20).
                        enum:
                        - per_unit
                        - flat_fee
                        - package
                        example: null
                      example: null
                    package_size:
                      type: array
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        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:
              - id
              - item_id
              - name
              example: null
            encoding:
              accounting_detail:
                style: deepObject
                explode: true
              tax_detail:
                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:
                  item_price:
                    $ref: "#/components/schemas/ItemPrice"
                    description: |
                      Resource object representing item_price
                required:
                - 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: []
  /attached_items/{attached-item-id}:
    get:
      tags:
      - attached_items
      summary: Retrieve an attached item
      description: |
        Retrieves details of an attached addon or a charge item.
      operationId: retrieve_an_attached_item_
      parameters:
      - name: parent_item_id
        in: query
        description: |
          The `id`
          of the plan-item to which the item is attached.
        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})))?::)))))$"
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: attached-item-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/attached-item-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  attached_item:
                    $ref: "#/components/schemas/AttachedItem"
                    description: |
                      Resource object representing attached_item
                required:
                - attached_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:
      tags:
      - attached_items
      summary: Update an attached item
      description: |
        Updates an attached addon or a charge item for a plan.
      operationId: update_an_attached_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: attached-item-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/attached-item-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                parent_item_id:
                  type: string
                  deprecated: false
                  description: |
                    The id of the parent item in the attachment relationship.
                  maxLength: 100
                  example: null
                type:
                  type: string
                  deprecated: false
                  description: |
                    The type of attachment for the addon. Only applicable for addon-items and is a required parameter as well for addon-items.

                    * recommended -
                      The addon is recommended to go with the plan-item when using [Checkout](https://www.chargebee.com/docs/2.0/configure-inapp.html#fundamental-settings_recommending-addons-in-checkout)
                      or [Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html#allow-change-subscription)
                      .
                    * optional -
                      The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a `quantity`
                      and `billing_cycles`
                      for the addon, for when it is applied to subscriptions with the plan.
                    * mandatory -
                      The addon is attached automatically to the subscription for the plan-item unless [explicitly removed](/docs/api/subscriptions)
                      via API.
                  enum:
                  - recommended
                  - mandatory
                  - optional
                  example: null
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of subscription billing cycles for which this item is attached when applied to a subscription. Applicable only for items of type addon. Requires [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)
                    to be enabled for the site.

                    The value set explicitly for `billing_cycles`
                    while [applying the addon to a subscription](/docs/api/subscriptions/subscription-object#subscription_items)
                    takes precedence over this parameter. This parameter, in turn, has a higher precedence than [the value set for the addon-item price](/docs/api/item_prices)
                    .
                  minimum: 1
                  example: null
                quantity:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The default quantity of the addon to be attached when the quantity is not specified while [creating](/docs/api/subscriptions/create-subscription-for-items)
                    /[updating](/docs/api/subscriptions/update-subscription-for-items)
                    the subscription.
                  minimum: 1
                  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/getting-started)
                    is enabled.
                  maxLength: 33
                  example: null
                charge_on_event:
                  type: string
                  deprecated: false
                  description: |
                    Indicates when the item is charged. This parameter only applies to charge-items.

                    * contract_termination -
                      when a contract term is [terminated](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option)
                      .
                    * subscription_creation - the time of creation of the subscription.
                    * subscription_trial_start - the time when the trial period of the subscription begins.
                    * on_demand - Item can be charged on demand
                    * plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                    * subscription_activation -
                      the moment a subscription enters an `active`
                      or `non-renewing`
                      state. Also includes reactivations of canceled subscriptions.
                  enum:
                  - subscription_creation
                  - subscription_trial_start
                  - plan_activation
                  - subscription_activation
                  - contract_termination
                  - on_demand
                  example: null
                charge_once:
                  type: boolean
                  deprecated: false
                  description: |
                    Indicates if the charge-item is to be charged only once or each time the `charge_on_event`
                    occurs. This parameter only applies to charge-items.
                  example: null
              required:
              - parent_item_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  attached_item:
                    $ref: "#/components/schemas/AttachedItem"
                    description: |
                      Resource object representing attached_item
                required:
                - attached_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: []
  /items/{item-id}/attached_items:
    get:
      tags:
      - items
      summary: List attached items
      description: |
        Returns a list of attached items satisfying **all**
        the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
      operationId: list_attached_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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: item-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/item-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: id
        in: query
        description: |
          optional, string filter

          Filter attached items based on their id.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *id\[is\] = "bec0c324-adb6-44d3-ad4f-694f449be97c"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: bec0c324-adb6-44d3-ad4f-694f449be97c
          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: item_id
        in: query
        description: |
          optional, string filter

          Filter attached items based on the `item_id`
          of the item being attached.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *item_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: type
        in: query
        description: |
          optional, enumerated string filter

          Filter attached items based on the `type`
          of attached item. Possible values are : `recommended`
          , `mandatory`
          , `optional`.
          Possible values are : recommended, mandatory, optional.

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

          **Example →**
          *type\[is\] = "mandatory"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: mandatory
          properties:
            is:
              type: string
              description: |
                * `recommended` - The addon is recommended to go with the plan-item when using [Checkout](https://www.chargebee.com/docs/2.0/configure-inapp.html#fundamental-settings_recommending-addons-in-checkout) or [Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html#allow-change-subscription).
                * `mandatory` - The addon is attached automatically to the subscription for the plan-item unless [explicitly removed](./subscriptions?prod_cat_ver=2) via API.
                * `optional` - The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a `quantity` and `billing_cycles` for the addon, for when it is applied to subscriptions with the plan.
              enum:
              - recommended
              - mandatory
              - optional
              example: null
            is_not:
              type: string
              description: |
                * `recommended` - The addon is recommended to go with the plan-item when using [Checkout](https://www.chargebee.com/docs/2.0/configure-inapp.html#fundamental-settings_recommending-addons-in-checkout) or [Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html#allow-change-subscription).
                * `mandatory` - The addon is attached automatically to the subscription for the plan-item unless [explicitly removed](./subscriptions?prod_cat_ver=2) via API.
                * `optional` - The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a `quantity` and `billing_cycles` for the addon, for when it is applied to subscriptions with the plan.
              enum:
              - recommended
              - mandatory
              - optional
              example: null
            in:
              type: string
              description: |
                * `recommended` - The addon is recommended to go with the plan-item when using [Checkout](https://www.chargebee.com/docs/2.0/configure-inapp.html#fundamental-settings_recommending-addons-in-checkout) or [Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html#allow-change-subscription).
                * `mandatory` - The addon is attached automatically to the subscription for the plan-item unless [explicitly removed](./subscriptions?prod_cat_ver=2) via API.
                * `optional` - The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a `quantity` and `billing_cycles` for the addon, for when it is applied to subscriptions with the plan.
              enum:
              - recommended
              - mandatory
              - optional
              pattern: "^\\[(recommended|mandatory|optional)(,(recommended|mandatory|optional))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                * `recommended` - The addon is recommended to go with the plan-item when using [Checkout](https://www.chargebee.com/docs/2.0/configure-inapp.html#fundamental-settings_recommending-addons-in-checkout) or [Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html#allow-change-subscription).
                * `mandatory` - The addon is attached automatically to the subscription for the plan-item unless [explicitly removed](./subscriptions?prod_cat_ver=2) via API.
                * `optional` - The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a `quantity` and `billing_cycles` for the addon, for when it is applied to subscriptions with the plan.
              enum:
              - recommended
              - mandatory
              - optional
              pattern: "^\\[(recommended|mandatory|optional)(,(recommended|mandatory|optional))*\\\
                ]$"
              example: null
      - name: item_type
        in: query
        description: |
          optional, enumerated string filter

          To filter based on the type of of the attached item. Possible values are : `addon`
          , `charge`.
          Possible values are : plan, addon, charge.

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

          **Example →**
          *item_type\[is_not\] = "plan"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: plan
          properties:
            is:
              type: string
              description: |
                * `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.
                * `addon` - A recurring component that can be added to a subscription in addition to its plan.
                * `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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.
              enum:
              - plan
              - addon
              - charge
              example: null
            is_not:
              type: string
              description: |
                * `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.
                * `addon` - A recurring component that can be added to a subscription in addition to its plan.
                * `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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.
              enum:
              - plan
              - addon
              - charge
              example: null
            in:
              type: string
              description: |
                * `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.
                * `addon` - A recurring component that can be added to a subscription in addition to its plan.
                * `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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.
              enum:
              - plan
              - addon
              - charge
              pattern: "^\\[(plan|addon|charge)(,(plan|addon|charge))*\\]$"
              example: null
            not_in:
              type: string
              description: |
                * `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.
                * `addon` - A recurring component that can be added to a subscription in addition to its plan.
                * `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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.
              enum:
              - plan
              - addon
              - charge
              pattern: "^\\[(plan|addon|charge)(,(plan|addon|charge))*\\]$"
              example: null
      - name: charge_on_event
        in: query
        description: |
          optional, enumerated string filter

          Indicates when the item is charged. This attribute only applies to charge-items. Possible values are : subscription_creation, subscription_trial_start, plan_activation, subscription_activation, contract_termination, on_demand.

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

          **Example →**
          *charge_on_event\[is\] = "subscription_creation"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: subscription_creation
          properties:
            is:
              type: string
              description: |
                * `subscription_creation` - the time of creation of the subscription.
                * `subscription_trial_start` - the time when the trial period of the subscription begins.
                * `plan_activation` - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                * `subscription_activation` - the moment a subscription enters an `active` or `non-renewing` state. Also includes reactivations of canceled subscriptions.
                * `contract_termination` - when a contract term is [terminated](./subscriptions?prod_cat_ver=2#cancel_subscription_for_items_contract_term_cancel_option).
                * `on_demand` - Item can be charged on demand
              enum:
              - subscription_creation
              - subscription_trial_start
              - plan_activation
              - subscription_activation
              - contract_termination
              - on_demand
              example: null
            is_not:
              type: string
              description: |
                * `subscription_creation` - the time of creation of the subscription.
                * `subscription_trial_start` - the time when the trial period of the subscription begins.
                * `plan_activation` - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                * `subscription_activation` - the moment a subscription enters an `active` or `non-renewing` state. Also includes reactivations of canceled subscriptions.
                * `contract_termination` - when a contract term is [terminated](./subscriptions?prod_cat_ver=2#cancel_subscription_for_items_contract_term_cancel_option).
                * `on_demand` - Item can be charged on demand
              enum:
              - subscription_creation
              - subscription_trial_start
              - plan_activation
              - subscription_activation
              - contract_termination
              - on_demand
              example: null
            in:
              type: string
              description: |
                * `subscription_creation` - the time of creation of the subscription.
                * `subscription_trial_start` - the time when the trial period of the subscription begins.
                * `plan_activation` - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                * `subscription_activation` - the moment a subscription enters an `active` or `non-renewing` state. Also includes reactivations of canceled subscriptions.
                * `contract_termination` - when a contract term is [terminated](./subscriptions?prod_cat_ver=2#cancel_subscription_for_items_contract_term_cancel_option).
                * `on_demand` - Item can be charged on demand
              enum:
              - subscription_creation
              - subscription_trial_start
              - plan_activation
              - subscription_activation
              - contract_termination
              - on_demand
              pattern: "^\\[(subscription_creation|subscription_trial_start|plan_activation|subscription_activation|contract_termination|on_demand)(,(subscription_creation|subscription_trial_start|plan_activation|subscription_activation|contract_termination|on_demand))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                * `subscription_creation` - the time of creation of the subscription.
                * `subscription_trial_start` - the time when the trial period of the subscription begins.
                * `plan_activation` - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                * `subscription_activation` - the moment a subscription enters an `active` or `non-renewing` state. Also includes reactivations of canceled subscriptions.
                * `contract_termination` - when a contract term is [terminated](./subscriptions?prod_cat_ver=2#cancel_subscription_for_items_contract_term_cancel_option).
                * `on_demand` - Item can be charged on demand
              enum:
              - subscription_creation
              - subscription_trial_start
              - plan_activation
              - subscription_activation
              - contract_termination
              - on_demand
              pattern: "^\\[(subscription_creation|subscription_trial_start|plan_activation|subscription_activation|contract_termination|on_demand)(,(subscription_creation|subscription_trial_start|plan_activation|subscription_activation|contract_termination|on_demand))*\\\
                ]$"
              example: null
      - name: updated_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          Filter attached items based on when the attached items were last updated.
          **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
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        attached_item:
                          $ref: "#/components/schemas/AttachedItem"
                          description: Resource object representing attached_item
                      required:
                      - attached_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:
      tags:
      - items
      summary: Create an attached item
      description: |
        Creates an attached addon or a charge item for a plan.
      operationId: create_an_attached_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: item-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/item-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                item_id:
                  type: string
                  deprecated: false
                  description: |
                    The id of the addon or charge that is being attached to the plan-item.
                  maxLength: 100
                  example: null
                type:
                  type: string
                  deprecated: false
                  description: |
                    The type of attachment for the addon. Only applicable for addon-items and is a required parameter as well for addon-items.

                    * recommended -
                      The addon is recommended to go with the plan-item when using [Checkout](https://www.chargebee.com/docs/2.0/configure-inapp.html#fundamental-settings_recommending-addons-in-checkout)
                      or [Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html#allow-change-subscription)
                      .
                    * optional -
                      The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a `quantity`
                      and `billing_cycles`
                      for the addon, for when it is applied to subscriptions with the plan.
                    * mandatory -
                      The addon is attached automatically to the subscription for the plan-item unless [explicitly removed](/docs/api/subscriptions)
                      via API.
                  enum:
                  - recommended
                  - mandatory
                  - optional
                  example: null
                billing_cycles:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of subscription billing cycles for which this item is attached when applied to a subscription. Applicable only for items of type addon. Requires [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)
                    to be enabled for the site.

                    The value set explicitly for `billing_cycles`
                    while [applying the addon to a subscription](/docs/api/subscriptions/subscription-object#subscription_items)
                    takes precedence over this parameter. This parameter, in turn, has a higher precedence than [the value set for the addon-item price](/docs/api/item_prices)
                    .
                  minimum: 1
                  example: null
                quantity:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The default quantity of the addon to be attached when the quantity is not specified while [creating](/docs/api/subscriptions/create-subscription-for-items)
                    /[updating](/docs/api/subscriptions/update-subscription-for-items)
                    the subscription.
                  minimum: 1
                  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/getting-started)
                    is enabled.
                  maxLength: 33
                  example: null
                charge_on_event:
                  type: string
                  deprecated: false
                  description: |
                    Indicates when the item is charged. This parameter only applies to charge-items.

                    * contract_termination -
                      when a contract term is [terminated](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option)
                      .
                    * subscription_creation - the time of creation of the subscription.
                    * subscription_trial_start - the time when the trial period of the subscription begins.
                    * on_demand - Item can be charged on demand
                    * plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                    * subscription_activation -
                      the moment a subscription enters an `active`
                      or `non-renewing`
                      state. Also includes reactivations of canceled subscriptions.
                  enum:
                  - subscription_creation
                  - subscription_trial_start
                  - plan_activation
                  - subscription_activation
                  - contract_termination
                  - on_demand
                  example: null
                charge_once:
                  type: boolean
                  deprecated: false
                  description: |
                    Indicates if the charge-item is to be charged only once or each time the `charge_on_event`
                    occurs. This parameter only applies to charge-items.
                  example: null
                business_entity_id:
                  type: string
                  deprecated: false
                  description: |
                    The unique ID of the [business entity](/docs/api/business_entities) for this `attached_item`. This is applicable only when multiple business entities have been created for the site. When provided, the operation will read or write data associated with the specified business entity. If not provided, the resource will be created at the site level, and the `business_entity_id` will not be included in the API response.

                    **Note** : An alternative way of passing this parameter is by using a [custom HTTP header](/docs/api/advanced-features) or [query string parameter](/docs/api/advanced-features#mbe-alternative).
                  maxLength: 50
                  example: null
              required:
              - item_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  attached_item:
                    $ref: "#/components/schemas/AttachedItem"
                    description: |
                      Resource object representing attached_item
                required:
                - attached_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: []
  /attached_items/{attached-item-id}/delete:
    post:
      tags:
      - attached_items
      summary: Delete an attached item
      description: |
        Deletes an attached addon or a charge item.
      operationId: delete_an_attached_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: attached-item-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/attached-item-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                parent_item_id:
                  type: string
                  deprecated: false
                  description: |
                    The id of the addon or charge that is being attached to the plan-item.
                  maxLength: 100
                  example: null
              required:
              - parent_item_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  attached_item:
                    $ref: "#/components/schemas/AttachedItem"
                    description: |
                      Resource object representing attached_item
                required:
                - attached_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: []
  /differential_prices/{differential-price-id}/delete:
    post:
      tags:
      - differential_prices
      summary: Delete a differential price
      description: |
        Delete a differential price using a `differential_price_id`
        and `item_price_id`
        .
      operationId: delete_a_differential_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: differential-price-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/differential-price-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                item_price_id:
                  type: string
                  deprecated: false
                  description: |
                    The id of the item price (`addon`
                    or `charge`
                    ) whose price should change according to the plan-item it is applied to.
                  maxLength: 100
                  example: null
              required:
              - item_price_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  differential_price:
                    $ref: "#/components/schemas/DifferentialPrice"
                    description: |
                      Resource object representing differential_price
                required:
                - differential_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: []
  /item_prices/{item-price-id}/differential_prices:
    post:
      tags:
      - item_prices
      summary: Create a differential price
      description: |
        Create a differential price for addon item price, addon item price with tiered pricing, or charge item price.
      operationId: create_a_differential_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: item-price-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/item-price-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                parent_item_id:
                  type: string
                  deprecated: false
                  description: |
                    The id of the plan-item, in relation to which, the differential pricing for the addon or charge is defined. For example, this would be the id of the *Standard*
                    or *Enterprise*
                    plans-items mentioned in the [examples above](/docs/api/differential_prices)
                    .
                  maxLength: 100
                  example: null
                price:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    The differential price. If the pricing model of the `item_price_id`
                    is `tiered`
                    , `volume`
                    , or `stairstep`
                    , pass `tiers`
                    instead of this.
                  minimum: 0
                  example: null
                price_in_decimal:
                  type: string
                  deprecated: false
                  description: |
                    The price of the item when the pricing_model is `flat_fee`.
                    When the pricing model is `per_unit`
                    , 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 [multi-decimal pricing](/docs/api/currencies)
                    is enabled.
                  maxLength: 39
                  example: null
                business_entity_id:
                  type: string
                  deprecated: false
                  description: |
                    The unique ID of the [business entity](/docs/api/business_entities) for this `differential_price`. This is applicable only when multiple business entities have been created for the site. When provided, the operation will read or write data associated with the specified business entity. If not provided, the resource will be created at the site level, and the business_entity_id will not be included in the API response.

                    **Note** : An alternative way of passing this parameter is by using a [custom HTTP header](/docs/api/advanced-features) or [query string parameter](/docs/api/advanced-features#mbe-alternative).
                  maxLength: 50
                  example: null
                parent_periods:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for parent_periods
                  properties:
                    period_unit:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The unit of time for `period`
                          .

                          * month - A period of 1 calendar month.
                          * day - A period of 24 hours.
                          * week - A period of 7 days.
                          * year - A period of 1 calendar year.
                        enum:
                        - day
                        - week
                        - month
                        - year
                        example: null
                      example: null
                    period:
                      type: array
                      description: "The billing period of the plan in `period_unit`\n\
                        s. For example, a 6 month plan has `period`\nas 6 and `period_unit`\n\
                        as `month`.  \n**Note**\nFor a [charge-item price](/docs/api/item_prices),\n\
                        \n* When `parent_periods[period_unit]` and `parent_periods[period]`\
                        \ values are **passed** , then the [price](/docs/api/differential_prices/create-a-differential-price#price)\
                        \ is applied to a **specific** billing frequency of the plan-item.\n\
                        * When `parent_periods[period_unit]` and `parent_periods[period]`\
                        \ values are **not passed** , then the [price](/docs/api/differential_prices/create-a-differential-price#price)\
                        \ is applied to **all** billing frequencies of the plan-item.\n\
                        * When parent_periods\\[period_unit\\] is **passed** (eg.\
                        \ month) and the `parent_periods[period]` value is **not passed**\
                        \ , then the price is applied to all `parent_periods[period_unit]`\
                        \ (eg. monthly) frequencies of the plan-item. Updating or\
                        \ deleting the [price](/docs/api/differential_prices/create-a-differential-price#price)\
                        \ after creation will impact all of its related plan-item\
                        \ frequencies.\n"
                      items:
                        type: array
                        deprecated: false
                        items:
                          example: null
                        example: null
                      example: null
                  required:
                  - period_unit
                  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: |
                        The per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`
                        ; the total cost for the item price when the `pricing_model`
                        is `stairstep`.
                        The value is in the [minor unit of the currency](/docs/api/currencies)
                        .
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the `pricing_model`
                        is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the `pricing_model`
                        is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , 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 [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    pricing_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Pricing type for the tier.

                          * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                          * flat_fee -
                            Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                            pricing model, `pricing_type`
                            will be set to `flat_fee`
                            by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                          * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                        enum:
                        - per_unit
                        - flat_fee
                        - package
                        example: null
                      example: null
                    package_size:
                      type: array
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                  example: null
              required:
              - parent_item_id
              example: null
            encoding:
              parent_periods:
                style: deepObject
                explode: true
              tiers:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  differential_price:
                    $ref: "#/components/schemas/DifferentialPrice"
                    description: |
                      Resource object representing differential_price
                required:
                - differential_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: []
  /differential_prices:
    get:
      tags:
      - differential_prices
      summary: List differential prices
      description: |
        Returns a list of differential prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
      operationId: list_differential_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: item_price_id
        in: query
        description: |
          optional, string filter

          The id of the item price (`addon`
          or `charge`
          ) whose price should change according to the plan-item it is applied to.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *item_price_id\[is\] = "day-pass-USD"*
        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
            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: item_id
        in: query
        description: |
          optional, string filter

          Item Id of Addon / Charge item price for which differential pricing is applied to.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

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

          A unique and immutable id for the differential price. It is auto-generated when the differential price is created.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

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

          The id of the plan-item, in relation to which, the differential pricing for the addon or charge is defined. For example, this would be the id of the *Standard*
          or *Enterprise*
          plans-items mentioned in the [examples above](/docs/api/differential_prices)
          .
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *parent_item_id\[is_not\] = "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
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        differential_price:
                          $ref: "#/components/schemas/DifferentialPrice"
                          description: Resource object representing differential_price
                      required:
                      - differential_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: []
  /differential_prices/{differential-price-id}:
    get:
      tags:
      - differential_prices
      summary: Retrieve a differential price
      description: |
        Retrieve a differential price using a `differential_price_id`
        and `item_price_id`
        .
      operationId: retrieve_a_differential_price
      parameters:
      - name: item_price_id
        in: query
        description: |
          The id of the item price (`addon`
          or `charge`
          ) whose price should change according to the plan-item it is applied to.
        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})))?::)))))$"
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: differential-price-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/differential-price-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  differential_price:
                    $ref: "#/components/schemas/DifferentialPrice"
                    description: |
                      Resource object representing differential_price
                required:
                - differential_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:
      tags:
      - differential_prices
      summary: Update a differential price
      description: |
        Update a differential price using a `differential_price_id`
        and `item_price_id`
        .
      operationId: update_a_differential_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: differential-price-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/differential-price-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                item_price_id:
                  type: string
                  deprecated: false
                  description: |
                    The id of the item price (`addon`
                    or `charge`
                    ) whose price should change according to the plan-item it is applied to.
                  maxLength: 100
                  example: null
                price:
                  type: integer
                  format: int64
                  deprecated: false
                  description: |
                    The differential price. If the pricing model of the `item_price_id`
                    is `tiered`
                    , `volume`
                    , or `stairstep`
                    , pass `tiers`
                    instead of this.
                  minimum: 0
                  example: null
                price_in_decimal:
                  type: string
                  deprecated: false
                  description: |
                    The price of the item when the pricing_model is `flat_fee`.
                    When the pricing model is `per_unit`
                    , 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 [multi-decimal pricing](/docs/api/currencies)
                    is enabled.
                  maxLength: 39
                  example: null
                parent_periods:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for parent_periods
                  properties:
                    period_unit:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The unit of time for `period`
                          .

                          * month - A period of 1 calendar month.
                          * day - A period of 24 hours.
                          * week - A period of 7 days.
                          * year - A period of 1 calendar year.
                        enum:
                        - day
                        - week
                        - month
                        - year
                        example: null
                      example: null
                    period:
                      type: array
                      description: "The billing period of the plan in `period_unit`\n\
                        s. For example, a 6 month plan has `period`\nas 6 and `period_unit`\n\
                        as `month`.  \n**Note**\nFor a [charge-item price](/docs/api/item_prices),\n\
                        \n* When `parent_periods[period_unit]` and `parent_periods[period]`\
                        \ values are **passed** , then the [price](/docs/api/differential_prices/create-a-differential-price#price)\
                        \ is applied to a **specific** billing frequency of the plan-item.\n\
                        * When `parent_periods[period_unit]` and `parent_periods[period]`\
                        \ values are **not passed** , then the [price](/docs/api/differential_prices/create-a-differential-price#price)\
                        \ is applied to **all** billing frequencies of the plan-item.\n\
                        * When parent_periods\\[period_unit\\] is **passed** (eg.\
                        \ month) and the `parent_periods[period]` value is **not passed**\
                        \ , then the price is applied to all `parent_periods[period_unit]`\
                        \ (eg. monthly) frequencies of the plan-item. Updating or\
                        \ deleting the [price](/docs/api/differential_prices/create-a-differential-price#price)\
                        \ after creation will impact all of its related plan-item\
                        \ frequencies.\n"
                      items:
                        type: array
                        deprecated: false
                        items:
                          example: null
                        example: null
                      example: null
                  required:
                  - period_unit
                  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: |
                        The per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`
                        ; the total cost for the item price when the `pricing_model`
                        is `stairstep`.
                        The value is in the [minor unit of the currency](/docs/api/currencies)
                        .
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the `pricing_model`
                        is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the `pricing_model`
                        is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , 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 [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    pricing_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Pricing type for the tier.

                          * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                          * flat_fee -
                            Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                            pricing model, `pricing_type`
                            will be set to `flat_fee`
                            by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                          * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                        enum:
                        - per_unit
                        - flat_fee
                        - package
                        example: null
                      example: null
                    package_size:
                      type: array
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                  example: null
              required:
              - item_price_id
              example: null
            encoding:
              parent_periods:
                style: deepObject
                explode: true
              tiers:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  differential_price:
                    $ref: "#/components/schemas/DifferentialPrice"
                    description: |
                      Resource object representing differential_price
                required:
                - differential_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: []
  /configurations:
    get:
      tags:
      - configurations
      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})))?::)))))$"
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  configurations:
                    type: array
                    description: |
                      Resource object representing configuration
                    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: []
  /features:
    get:
      tags:
      - features
      summary: List features
      description: |
        Retrieves a list of features meeting **all**
        the conditions specified in the filter parameters.
      operationId: list_features
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: name
        in: query
        description: |
          optional, string filter

          A case-sensitive unique name for the feature. For example: `user license`
          , `data storage`
          , `Salesforce Integration`
          , `devices`
          , `UHD Streaming`
          , and so on.

          **Note:**
          This name is not displayed on any customer-facing documents or pages such as [invoice PDFs](/docs/api/invoices/retrieve-invoice-as-pdf)
          or [hosted pages](/docs/api/hosted_pages).
          However, in the future, it is likely to be introduced on the [Self-Serve Portal](/docs/api/portal_sessions)
          .
          **Supported operators :**
          is, is_not, starts_with, in, not_in

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

          A unique and immutable identifier for the feature. You can set it yourself, in which case it is recommended that a human-readable format (or slug) be used. For example, `number-of-users-ccjht01`.
          When not provided, a random value is automatically set.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *id\[is\] = "fea-user-licenses"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: fea-user-licenses
          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 current status of the feature. Possible values are : active, archived, draft.

          **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` - A `draft` or an `archived` feature can be changed to `active`. Any [item](item_entitlements) or [subscription entitlements](subscription_entitlements) defined for the feature take effect immediately.
                * `archived` - An `active` feature can be changed to `archived`. Once `archived`, no **new** [item](item_entitlements) or [subscription entitlements](subscription_entitlements) can be created for the feature. However, any pre-existing item or subscription entitlements from the time that the feature was `active`, remain effective.
                * `draft` - The feature is in an unpublished state. [Item](item_entitlements) and [subscription entitlements](subscription_entitlements) can be created for a draft feature but they are not effective until the feature is active. A feature `status` cannot be changed back to `draft` once it is in `active` or `archived` `status`.
              enum:
              - active
              - archived
              - draft
              example: null
            is_not:
              type: string
              description: |
                * `active` - A `draft` or an `archived` feature can be changed to `active`. Any [item](item_entitlements) or [subscription entitlements](subscription_entitlements) defined for the feature take effect immediately.
                * `archived` - An `active` feature can be changed to `archived`. Once `archived`, no **new** [item](item_entitlements) or [subscription entitlements](subscription_entitlements) can be created for the feature. However, any pre-existing item or subscription entitlements from the time that the feature was `active`, remain effective.
                * `draft` - The feature is in an unpublished state. [Item](item_entitlements) and [subscription entitlements](subscription_entitlements) can be created for a draft feature but they are not effective until the feature is active. A feature `status` cannot be changed back to `draft` once it is in `active` or `archived` `status`.
              enum:
              - active
              - archived
              - draft
              example: null
            in:
              type: string
              description: |
                * `active` - A `draft` or an `archived` feature can be changed to `active`. Any [item](item_entitlements) or [subscription entitlements](subscription_entitlements) defined for the feature take effect immediately.
                * `archived` - An `active` feature can be changed to `archived`. Once `archived`, no **new** [item](item_entitlements) or [subscription entitlements](subscription_entitlements) can be created for the feature. However, any pre-existing item or subscription entitlements from the time that the feature was `active`, remain effective.
                * `draft` - The feature is in an unpublished state. [Item](item_entitlements) and [subscription entitlements](subscription_entitlements) can be created for a draft feature but they are not effective until the feature is active. A feature `status` cannot be changed back to `draft` once it is in `active` or `archived` `status`.
              enum:
              - active
              - archived
              - draft
              pattern: "^\\[(active|archived|draft)(,(active|archived|draft))*\\]$"
              example: null
            not_in:
              type: string
              description: |
                * `active` - A `draft` or an `archived` feature can be changed to `active`. Any [item](item_entitlements) or [subscription entitlements](subscription_entitlements) defined for the feature take effect immediately.
                * `archived` - An `active` feature can be changed to `archived`. Once `archived`, no **new** [item](item_entitlements) or [subscription entitlements](subscription_entitlements) can be created for the feature. However, any pre-existing item or subscription entitlements from the time that the feature was `active`, remain effective.
                * `draft` - The feature is in an unpublished state. [Item](item_entitlements) and [subscription entitlements](subscription_entitlements) can be created for a draft feature but they are not effective until the feature is active. A feature `status` cannot be changed back to `draft` once it is in `active` or `archived` `status`.
              enum:
              - active
              - archived
              - draft
              pattern: "^\\[(active|archived|draft)(,(active|archived|draft))*\\]$"
              example: null
      - name: type
        in: query
        description: |
          optional, enumerated string filter

          The type of feature. Possible values are : switch, custom, quantity, range.

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

          **Example →**
          *type\[is\] = "boolean"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: boolean
          properties:
            is:
              type: string
              description: |
                * `switch` - A switch or toggle is a feature that an item or subscription can be either fully entitled to or not entitled to at all.
                * `custom` - The entitlement levels available for this feature are defined as a set of custom values. For example, a feature `Email Support` can have entitlement levels as `24×7` and `24×5`.
                * `quantity` - The feature is quantity-based and entitlement levels available for it are a set of predefined number of quantity units. For example, a feature with `name` such as `number of users` can have entitlement levels of say, `5`, `20`, `50`, and `100`. `levels[is_unlimited]` is used for specifying the "unlimited" entitlement level.
                * `range` - The feature is quantity-based and the entitlement levels available for it are the set of whole numbers within a range. The range is defined by a minimum and a maximum value. For example, a feature such as `number of users` can have entitlement levels starting at `5` users and go up to `50000`. `levels[is_unlimited]` is used for specifying the "unlimited" entitlement level.
              enum:
              - switch
              - custom
              - quantity
              - range
              example: null
            is_not:
              type: string
              description: |
                * `switch` - A switch or toggle is a feature that an item or subscription can be either fully entitled to or not entitled to at all.
                * `custom` - The entitlement levels available for this feature are defined as a set of custom values. For example, a feature `Email Support` can have entitlement levels as `24×7` and `24×5`.
                * `quantity` - The feature is quantity-based and entitlement levels available for it are a set of predefined number of quantity units. For example, a feature with `name` such as `number of users` can have entitlement levels of say, `5`, `20`, `50`, and `100`. `levels[is_unlimited]` is used for specifying the "unlimited" entitlement level.
                * `range` - The feature is quantity-based and the entitlement levels available for it are the set of whole numbers within a range. The range is defined by a minimum and a maximum value. For example, a feature such as `number of users` can have entitlement levels starting at `5` users and go up to `50000`. `levels[is_unlimited]` is used for specifying the "unlimited" entitlement level.
              enum:
              - switch
              - custom
              - quantity
              - range
              example: null
            in:
              type: string
              description: |
                * `switch` - A switch or toggle is a feature that an item or subscription can be either fully entitled to or not entitled to at all.
                * `custom` - The entitlement levels available for this feature are defined as a set of custom values. For example, a feature `Email Support` can have entitlement levels as `24×7` and `24×5`.
                * `quantity` - The feature is quantity-based and entitlement levels available for it are a set of predefined number of quantity units. For example, a feature with `name` such as `number of users` can have entitlement levels of say, `5`, `20`, `50`, and `100`. `levels[is_unlimited]` is used for specifying the "unlimited" entitlement level.
                * `range` - The feature is quantity-based and the entitlement levels available for it are the set of whole numbers within a range. The range is defined by a minimum and a maximum value. For example, a feature such as `number of users` can have entitlement levels starting at `5` users and go up to `50000`. `levels[is_unlimited]` is used for specifying the "unlimited" entitlement level.
              enum:
              - switch
              - custom
              - quantity
              - range
              pattern: "^\\[(switch|custom|quantity|range)(,(switch|custom|quantity|range))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |
                * `switch` - A switch or toggle is a feature that an item or subscription can be either fully entitled to or not entitled to at all.
                * `custom` - The entitlement levels available for this feature are defined as a set of custom values. For example, a feature `Email Support` can have entitlement levels as `24×7` and `24×5`.
                * `quantity` - The feature is quantity-based and entitlement levels available for it are a set of predefined number of quantity units. For example, a feature with `name` such as `number of users` can have entitlement levels of say, `5`, `20`, `50`, and `100`. `levels[is_unlimited]` is used for specifying the "unlimited" entitlement level.
                * `range` - The feature is quantity-based and the entitlement levels available for it are the set of whole numbers within a range. The range is defined by a minimum and a maximum value. For example, a feature such as `number of users` can have entitlement levels starting at `5` users and go up to `50000`. `levels[is_unlimited]` is used for specifying the "unlimited" entitlement level.
              enum:
              - switch
              - custom
              - quantity
              - range
              pattern: "^\\[(switch|custom|quantity|range)(,(switch|custom|quantity|range))*\\\
                ]$"
              example: null
      - name: metered
        in: query
        description: |
          optional, boolean filter

          Specifies whether the feature is a metered feature.

          **Supported operators :**
          is

          **Example →**
          *metered\[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
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        feature:
                          $ref: "#/components/schemas/Feature"
                          description: Resource object representing feature
                      required:
                      - feature
                      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:
      tags:
      - features
      summary: Create a feature
      description: "Creates a new feature.  \n**Note:** This operation creates non-metered\
        \ features only. To create a metered feature, use the [Create a metered feature](/docs/api/metered_features#create_a_metered_feature)\
        \ operation.\n"
      operationId: create_a_feature
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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 feature. You can set it yourself, in which case it is recommended that a human-readable format (or slug) be used. For example, `number-of-users-ccjht01`.
                    When not provided, a random value is automatically set.
                  maxLength: 50
                  example: null
                name:
                  type: string
                  deprecated: false
                  description: |
                    A case-sensitive unique name for the feature. For example: `user license`
                    , `data storage`
                    , `Salesforce Integration`
                    , `devices`
                    , `UHD Streaming`
                    , and so on.

                    **Note:**
                    This name is not displayed on any customer-facing documents or pages such as [invoice PDFs](/docs/api/invoices/retrieve-invoice-as-pdf)
                    or [hosted pages](/docs/api/hosted_pages).
                    However, in the future, it is likely to be introduced on the [Self-Serve Portal](/docs/api/portal_sessions)
                    .
                  maxLength: 50
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    A brief description of the feature. For example: `Access to 10TB cloud storage`
                    .
                  maxLength: 500
                  example: null
                type:
                  type: string
                  deprecated: false
                  description: |
                    The type of feature.

                    * quantity -
                      The feature is quantity-based and entitlement levels available for it are a set of predefined number of quantity units. For example, a feature with `name`
                      such as `number of users`
                      can have entitlement levels of say, `5`
                      , `20`
                      , `50`
                      , and `100`.
                      `levels[is_unlimited]`
                      is used for specifying the "unlimited" entitlement level.
                    * range -
                      The feature is quantity-based and the entitlement levels available for it are the set of whole numbers within a range. The range is defined by a minimum and a maximum value. For example, a feature such as `number of users`
                      can have entitlement levels starting at `5`
                      users and go up to `50000`.
                      `levels[is_unlimited]`
                      is used for specifying the "unlimited" entitlement level.
                    * switch - A switch or toggle is a feature that an item or subscription can be either fully entitled to or not entitled to at all.
                    * custom -
                      The entitlement levels available for this feature are defined as a set of custom values. For example, a feature `Email Support`
                      can have entitlement levels as `24×7`
                      and `24×5`
                      .
                  enum:
                  - switch
                  - custom
                  - quantity
                  - range
                  example: null
                status:
                  type: string
                  deprecated: false
                  description: |
                    The current status of the feature.

                    * active -
                      A `draft`
                      or an `archived`
                      feature can be changed to `active`.
                      Any [entitlements](/docs/api/entitlements)
                      or [subscription entitlements](/docs/api/subscription_entitlements)
                      defined for the feature take effect immediately.
                    * draft -
                      The feature is in an unpublished state. [Entitlements](/docs/api/entitlements)
                      and [subscription entitlements](/docs/api/subscription_entitlements)
                      can be created for a draft feature but they are not effective until the feature is active. A feature `status`
                      cannot be changed back to `draft`
                      once it is in `active`
                      or `archived`
                      `status`
                      .
                  enum:
                  - active
                  - draft
                  example: null
                unit:
                  type: string
                  deprecated: false
                  description: |
                    For features of `type`
                    `quantity`
                    or `range`
                    , this specifies the unit of measure. The value is expected in the singular form and when used by the system, it is pluralized automatically as needed. For example, for a feature such as `user licenses`
                    , the `unit`
                    can be `license`
                    .
                  maxLength: 50
                  example: null
                levels:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for levels
                  properties:
                    name:
                      type: array
                      description: |
                        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 `Email Support`
                        can have entitlement levels named as `All weekdays`
                        , `All days`
                        , `40 hours per week`
                        and so on.

                        When not provided for `feature.type`
                        `quantity`
                        or `range`
                        , this name is auto-generated as the space-separated concatenation of `levels[].value`
                        and the pluralized version of `unit`.
                        For example, if `levels[].value`
                        is `20`
                        and `unit`
                        is `user`
                        , then `levels[].name`
                        becomes `20 users`
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    value:
                      type: array
                      description: |
                        The value denoting the entitlement level granted.

                        * **When `type` is `quantity`:** this attribute denotes the quantity of units of the feature for this entitlement level. For example, a feature such as `number of users` can have `levels[].value` as `5`, `20`, `50`, and `100`. `levels[].is_unlimited` is used to set the entitlement level to "unlimited".
                        * **When `type` is `range`:** there can be be only two elements in the `levels[]` array; one corresponding to the minimum value (`levels[0]`) and the other to the maximum value (`levels[1]`) of the range of possible entitlement levels. For example, a feature such as `number of users` may have `levels[0].value` = `5` and `levels[1].value` = `50000`. When the upper limit is "unlimited", then `levels[1].value` is not set and `levels[1].is_unlimited` is `true`.
                        * **When `type` is `custom`:** this attribute denotes the value of this custom entitlement level. For example, a feature `Email Support` can have `levels[].value` as one of say, `24×7` and `24×5`.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    is_unlimited:
                      type: array
                      description: |
                        When `type` is `quantity` or `range`, this attribute indicates whether the entitlement level corresponds to unlimited units of the feature. Possible values are:

                        * `true`: The entitlement level corresponds to unlimited units of the feature. `levels[].value` is ignored for this level. This can only be set for the level that has the highest value for `levels[].level.`
                        * `false`: The entitlement level does not correspond to unlimited units of the feature.

                        Either this or levels\[value\] should be passed.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    level:
                      type: array
                      description: |
                        Represents the order of the entitlement levels from lowest to highest.

                        * **When `type` is `quantity` or `custom`:** Provide the `level` for the lowest entitlement level as `0`, the next higher level as `1`, followed by `2`, and so on.
                        * **When `type` is `range`:** Provide `0` for the minimum value and `1` for the maximum value in the range.

                        When not defined, it is assumed as the index of the `levels[]` array.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                  example: null
              required:
              - name
              example: null
            encoding:
              levels:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  feature:
                    $ref: "#/components/schemas/Feature"
                    description: |
                      Resource object representing feature
                required:
                - feature
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /features/{feature-id}/delete:
    post:
      tags:
      - features
      summary: Delete a feature
      description: |
        Deletes a feature. Any entitlements and subscription entitlements defined for the feature are also removed. This action is not permissible when the `status`
        of the feature is `active`
        .
      operationId: delete_a_feature
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: feature-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/feature-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  feature:
                    $ref: "#/components/schemas/Feature"
                    description: |
                      Resource object representing feature
                required:
                - feature
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /features/{feature-id}:
    get:
      tags:
      - features
      summary: Retrieve a feature
      description: |
        Retrieve a specific feature using its ID.
      operationId: retrieve_a_feature
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: feature-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/feature-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  feature:
                    $ref: "#/components/schemas/Feature"
                    description: |
                      Resource object representing feature
                required:
                - feature
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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:
      tags:
      - features
      summary: Update a feature
      description: "Updates a specific feature.  \n**Note**\n\nThe list of objects\
        \ `levels[]` provided as part of this operation fully replaces the existing\
        \ list of objects [levels[]](/docs/api/features/feature-object#levels) of\
        \ the feature.\n\n### Considerations when modifying `levels`\n\nThis section\
        \ describes validations that are performed by Chargebee when modifying the\
        \ `levels` list of objects for the feature, using this operation.\n\n####\
        \ Adding `levels`\n\nAdding a new object to the `levels[]` list is allowed\
        \ if and only if the feature [type](/docs/api/features/feature-object#type)\
        \ is `quantity` or `custom`\n\n#### Removing `levels`\n\nRemoving an existing\
        \ object in the `levels[]` list is not allowed if the `value` for that object\
        \ is currently mapped to one or more [item_entitlement](/docs/api/item_entitlements)s\
        \ or [subscription_entitlement](/docs/api/subscription_entitlements)s.\n\n\
        #### Reordering `levels`\n\n**Note**\n\nThe validation described in this section\
        \ is only applicable for features of `type` `custom`\n\nIf any of `levels[].value`\
        \ are currently mapped to `item_entitlement`s or `subscription_entitlement`s,\
        \ then the relative order of the corresponding `levels[].level` must be preserved\
        \ when invoking this operation.\n\nFor example, consider that the `levels[]`\
        \ list is currently in the state shown below. (For brevity, only the `value`\
        \ and `level` key are shown here and the JSONs have been compacted.)\n\n```js\n\
        \n{\n    \"levels\":[{\n        \"value\":\"email-basic\",\n        \"level\"\
        :0\n    },{\n        \"value\":\"email-rise\",\n        \"level\":1\n    },{\n\
        \        \"value\":\"email-advanced\",\n        \"level\":2\n    },{\n   \
        \     \"value\":\"email-pro\",\n        \"level\":3\n    },{\n        \"value\"\
        :\"email-scale\",\n        \"level\":4\n    }]\n}\n\n```\n\nNow consider that\
        \ `email-rise`, `email-advanced`, and `email-pro` have already been mapped\
        \ to `item_entitlement`s or `subscription_entitlement`s. As seen in the above\
        \ object, the relative order of `levels[].level` is such that `email-rise`\
        \ \\< `email-advanced` \\< `email-pro`.\n\nInvoking this API to change `levels[]`\
        \ to the state below is allowed since the relative order of `level` corresponding\
        \ to `email-rise`, `email-advanced`, and `email-pro` has been preserved.\n\
        \n```js\n\n{\n    \"levels\":[{\n        \"value\":\"email-basic\",\n    \
        \    \"level\":0\n    },{\n        \"value\":\"email-rise\",\n        \"level\"\
        :1\n    },{\n        \"value\":\"email-scale\",\n        \"level\":2\n   \
        \ },{\n        \"value\":\"email-advanced\",\n        \"level\":3\n    },{\n\
        \        \"value\":\"email-pro\",\n        \"level\":4\n    }]\n}\n\n```\n\
        \nHowever, changing `levels[]` to the state shown below is not permissible\
        \ because the `level` of `email-advanced` is provided as greater than the\
        \ `level` of `email-pro`, thereby disrupting the original order.\n\n```js\n\
        \n{\n    \"levels\":[{\n        \"value\":\"email-basic\",\n        \"level\"\
        :0\n    },{\n        \"value\":\"email-rise\",\n        \"level\":1\n    },{\n\
        \        \"value\":\"email-pro\",\n        \"level\":2\n    },{\n        \"\
        value\":\"email-advanced\",\n        \"level\":3\n    },{\n        \"value\"\
        :\"email-scale\",\n        \"level\":4\n    }]\n}\n\n```\n\n"
      operationId: update_a_feature
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: feature-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/feature-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: |
                    A case-sensitive unique name for the feature. For example: `user license`
                    , `data storage`
                    , `Salesforce Integration`
                    , `devices`
                    , `UHD Streaming`
                    , and so on.

                    **Note:**
                    This name is not displayed on any customer-facing documents or pages such as [invoice PDFs](/docs/api/invoices/retrieve-invoice-as-pdf)
                    or [hosted pages](/docs/api/hosted_pages).
                    However, in the future, it is likely to be introduced on the [Self-Serve Portal](/docs/api/portal_sessions)
                    .
                  maxLength: 50
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    A brief description of the feature. For example: `Access to 10TB cloud storage`
                    .
                  maxLength: 500
                  example: null
                status:
                  type: string
                  deprecated: false
                  description: |
                    The current status of the feature.

                    * active -
                      A `draft`
                      or an `archived`
                      feature can be changed to `active`.
                      Any [entitlements](/docs/api/entitlements)
                      or [subscription entitlements](/docs/api/subscription_entitlements)
                      defined for the feature take effect immediately.
                    * draft -
                      The feature is in an unpublished state. [Entitlements](/docs/api/entitlements)
                      and [subscription entitlements](/docs/api/subscription_entitlements)
                      can be created for a draft feature but they are not effective until the feature is active. A feature `status`
                      cannot be changed back to `draft`
                      once it is in `active`
                      or `archived`
                      `status`
                      .
                    * archived -
                      An `active`
                      feature can be changed to `archived`.
                      Once `archived`
                      , no **new**
                      [entitlements](/docs/api/entitlements)
                      or [subscription entitlements](/docs/api/subscription_entitlements)
                      can be created for the feature. However, any pre-existing item or subscription entitlements from the time that the feature was `active`
                      , remain effective.
                  enum:
                  - active
                  - archived
                  - draft
                  example: null
                unit:
                  type: string
                  deprecated: false
                  description: |
                    For features of `type`
                    `quantity`
                    or `range`
                    , this specifies the unit of measure. The value is expected in the singular form and when used by the system, it is pluralized automatically as needed. For example, for a feature such as `user licenses`
                    , the `unit`
                    can be `license`
                    .
                  maxLength: 50
                  example: null
                levels:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for levels
                  properties:
                    name:
                      type: array
                      description: |
                        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 `Email Support`
                        can have entitlement levels named as `All weekdays`
                        , `All days`
                        , `40 hours per week`
                        and so on.

                        When not provided for `feature.type`
                        `quantity`
                        or `range`
                        , this name is auto-generated as the space-separated concatenation of `levels[].value`
                        and the pluralized version of `unit`.
                        For example, if `levels[].value`
                        is `20`
                        and `unit`
                        is `user`
                        , then `levels[].name`
                        becomes `20 users`
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    value:
                      type: array
                      description: |
                        The value denoting the entitlement level granted.

                        * **When `type` is `quantity`:** this attribute denotes the quantity of units of the feature for this entitlement level. For example, a feature such as `number of users` can have `levels[].value` as `5`, `20`, `50`, and `100`. `levels[].is_unlimited` is used to set the entitlement level to "unlimited".
                        * **When `type` is `range`:** there can be only two elements in the `levels[]` array; one corresponding to the minimum value (`levels[0]`) and the other to the maximum value (`levels[1]`) of the range of possible entitlement levels. For example, a feature such as `number of users` may have `levels[0].value` = `5` and `levels[1].value` = `50000`. When the upper limit is "unlimited", then `levels[1].value` is not set and `levels[1].is_unlimited` is `true`.
                        * **When `type` is `custom`:** this attribute denotes the value of this custom entitlement level. For example, a feature `Email Support` can have `levels[].value` as one of say, `24×7` and `24×5`.

                        **Note**

                        This must be provided exactly as it already exists for the feature if the `value` is currently mapped to an [entitlement](/docs/api/entitlements)s or [subscription_entitlement](/docs/api/subscription_entitlements)s.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    is_unlimited:
                      type: array
                      description: |
                        When `type` is `quantity` or `range`, this attribute indicates whether the entitlement level corresponds to unlimited units of the feature. Possible values are:

                        * `true`: The entitlement level corresponds to unlimited units of the feature. `levels[].value` is ignored for this level. This can only be set for the level that has the highest value for `levels[].level.`
                        * `false`: The entitlement level does not correspond to unlimited units of the feature.

                        Either this or levels\[value\] should be passed.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    level:
                      type: array
                      description: |
                        Represents the order of the entitlement levels from lowest to highest.

                        * **When `type` is `quantity`:** Provide the `level` for the lowest entitlement level as `0`, the next higher level as `1`, followed by `2`, and so on.
                        * **When `type` is `custom`:** Provide the `level` for the lowest entitlement level as `0`, the next higher level as `1`, followed by `2`, and so on. **Note:** There are some validations to be considered.
                        * **When `type` is `range`:** Provide `0` for the minimum value and `1` for the maximum value in the range.

                        When not defined, it is assumed as the index of the `levels[]` array.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                  example: null
              example: null
            encoding:
              levels:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  feature:
                    $ref: "#/components/schemas/Feature"
                    description: |
                      Resource object representing feature
                required:
                - feature
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /features/{feature-id}/archive_command:
    post:
      tags:
      - features
      summary: Archive a feature
      description: "Archives an `active` feature so that no **new** [entitlements](/docs/api/entitlements)\
        \ or [subscription entitlements](/docs/api/subscription_entitlements) can\
        \ be created towards the feature. Any pre-existing item or subscription entitlements\
        \ from the time that the feature was `active` remain effective. This operation\
        \ changes the [status](/docs/api/features/feature-object#status) of the feature\
        \ to `archived`.  \n\n### Prerequisites \\& Constraints\n\n* Only a feature\
        \ in `active` status can be archived.\n* Calling this endpoint on a feature\
        \ that is already `archived` returns it unchanged.\n* A `draft` feature cannot\
        \ be archived.\n"
      operationId: archive_a_feature
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: feature-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/feature-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  feature:
                    $ref: "#/components/schemas/Feature"
                    description: |
                      Resource object representing feature
                required:
                - feature
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /features/{feature-id}/activate_command:
    post:
      tags:
      - features
      summary: Activate a feature
      description: "Activates a `draft` feature so that any [entitlements](/docs/api/entitlements)\
        \ or [subscription entitlements](/docs/api/subscription_entitlements) defined\
        \ towards it take effect immediately. This operation changes the [status](/docs/api/features/feature-object#status)\
        \ of the feature to `active`.  \n\n### Prerequisites \\& Constraints\n\n*\
        \ Only a feature in `draft` status can be activated.\n* Calling this endpoint\
        \ on a feature that is already `active` returns it unchanged.\n* An `archived`\
        \ feature cannot be reactivated using this endpoint. Use [Reactivate a feature](/docs/api/features/reactivate-a-feature)\
        \ instead.\n"
      operationId: activate_a_feature
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: feature-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/feature-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  feature:
                    $ref: "#/components/schemas/Feature"
                    description: |
                      Resource object representing feature
                required:
                - feature
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /features/{feature-id}/reactivate_command:
    post:
      tags:
      - features
      summary: Reactivate a feature
      description: "Reactivates an archived feature so that **new** [entitlements](/docs/api/entitlements)\
        \ or [subscription entitlements](/docs/api/subscription_entitlements) can\
        \ be created towards the feature. This operation changes the [status](/docs/api/features/feature-object#status)\
        \ of the feature to `active`.  \n\n### Prerequisites \\& Constraints\n\n*\
        \ Only a feature in `archived` status can be reactivated.\n* Calling this\
        \ endpoint on a feature that is already `active` returns it unchanged.\n*\
        \ A `draft` feature cannot be reactivated using this endpoint. Use [Activate\
        \ a feature](/docs/api/features/activate-a-feature) instead.\n"
      operationId: reactivate_a_feature
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: feature-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/feature-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  feature:
                    $ref: "#/components/schemas/Feature"
                    description: |
                      Resource object representing feature
                required:
                - feature
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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_units:
    get:
      tags:
      - credit_units
      summary: List credit units
      description: |
        Retrieves a paginated list of credit units meeting **all** the conditions specified in the filter parameters.
      operationId: list_credit_units
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: status
        in: query
        description: |
          optional, enumerated string filter

          The current lifecycle status of the credit unit. Possible values are : active, archived.

          **Supported operators :**
          is, in

          **Example →**
          *status\[is\] = "active"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: active
          properties:
            in:
              type: string
              description: |-
                * `active` - The credit unit is active.
                * `archived` - The credit unit is archived; it can be reactivated.
              enum:
              - active
              - archived
              pattern: "^\\[(active|archived)(,(active|archived))*\\]$"
              example: null
            is:
              type: string
              description: |-
                * `active` - The credit unit is active.
                * `archived` - The credit unit is archived; it can be reactivated.
              enum:
              - active
              - archived
              example: null
      - name: id
        in: query
        description: |
          optional, string filter

          The unique identifier of the credit unit.
          **Supported operators :**
          is, in

          **Example →**
          *id\[is\] = "ai_tokens_001"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: ai-tokens
          properties:
            in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
            is:
              type: string
              minLength: 1
              example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        credit_unit:
                          $ref: "#/components/schemas/CreditUnit"
                          description: Resource object representing credit_unit
                      required:
                      - credit_unit
                      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:
      tags:
      - credit_units
      summary: Create a credit unit
      description: |
        Creates a new credit unit in the `active` status.
      operationId: create_a_credit_unit
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                id:
                  type: string
                  deprecated: false
                  description: |
                    Unique identifier for the credit unit. Must be unique across the site.
                  maxLength: 50
                  example: null
                name:
                  type: string
                  deprecated: false
                  description: |
                    Internal display name for the credit unit. Must be unique across the site.
                  maxLength: 50
                  example: null
                is_unlimited:
                  type: boolean
                  deprecated: false
                  description: |
                    Indicates whether the credit unit allows unlimited overdraft consumption. When `true`, grace consumption continues without a cap after the allocated grants are exhausted. When `false`, provide `overdraft_amount` to cap the grace consumption.
                  example: null
                overdraft_amount:
                  type: string
                  deprecated: false
                  description: |
                    The amount up to which grace consumption is allowed after the allocated grants are exhausted. A positive decimal value that applies only when `is_unlimited` is `false`.
                  maxLength: 50
                  example: null
                external_name:
                  type: string
                  deprecated: false
                  description: |
                    Customer-facing display name for the credit unit. Must be unique across the site.
                    Defaults to `name` when omitted.
                  maxLength: 50
                  example: null
              required:
              - id
              - is_unlimited
              - name
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  credit_unit:
                    $ref: "#/components/schemas/CreditUnit"
                    description: |
                      Resource object representing credit unit
                required:
                - credit_unit
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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_units/{credit-unit-id}/archive_command:
    post:
      tags:
      - credit_units
      summary: Archive a credit unit
      description: |
        Archives an `active` credit unit. Once archived, the credit unit can no longer be used to create grant configurations for items and grant configuration overrides for subscriptions. Any grants that were already configured for this credit unit will continue to be effective.
      operationId: archive_a_credit_unit
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: credit-unit-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/credit-unit-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  credit_unit:
                    $ref: "#/components/schemas/CreditUnit"
                    description: |
                      Resource object representing credit unit
                required:
                - credit_unit
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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_units/{credit-unit-id}:
    post:
      tags:
      - credit_units
      summary: Update a credit unit
      description: |
        Updates an existing credit unit.
      operationId: update_a_credit_unit
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: credit-unit-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/credit-unit-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: |
                    Updated internal display name for the credit unit. Must be unique across the site.
                  maxLength: 50
                  example: null
                external_name:
                  type: string
                  deprecated: false
                  description: |
                    Updated customer-facing display name for the credit unit. Must be unique across the site.
                    At least one of `name` or `external_name` should be provided.
                    Only credit units with the `active` status can be updated.
                  maxLength: 50
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  credit_unit:
                    $ref: "#/components/schemas/CreditUnit"
                    description: |
                      Resource object representing credit unit
                required:
                - credit_unit
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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_units/{credit-unit-id}/reactivate_command:
    post:
      tags:
      - credit_units
      summary: Reactivate a credit unit
      description: |
        Reactivates an `archived` credit unit. Once reactivated, the credit unit can be used to configure grants for plans, add-ons, and charges, as well as grant configuration overrides for subscriptions.
      operationId: reactivate_a_credit_unit
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: credit-unit-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/credit-unit-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  credit_unit:
                    $ref: "#/components/schemas/CreditUnit"
                    description: |
                      Resource object representing credit unit
                required:
                - credit_unit
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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}/subscription_entitlements/set_availability:
    post:
      tags:
      - subscriptions
      summary: Enable or disable subscription entitlements
      description: |
        Enables or disables specific `subscription_entitlements` for a subscription.
      operationId: enable_or_disable_subscription_entitlements
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
                is_enabled:
                  type: boolean
                  deprecated: false
                  description: |
                    Specifies whether the `subscription_entitlements`
                    are to be enabled or disabled.
                  example: null
                subscription_entitlements:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription_entitlements
                  properties:
                    feature_id:
                      type: array
                      description: |
                        The `id`
                        of the feature towards which the `subscription_entitlement`
                        is to be enabled or disabled. An error is returned if a `subscription_entitlement`
                        does not exist for the feature.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  required:
                  - feature_id
                  example: null
              required:
              - is_enabled
              example: null
            encoding:
              subscription_entitlements:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        subscription_entitlement:
                          $ref: "#/components/schemas/SubscriptionEntitlement"
                          description: Resource object representing subscription_entitlement
                      required:
                      - subscription_entitlement
                      example: null
                    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}/subscription_entitlements:
    get:
      tags:
      - subscriptions
      summary: List subscription entitlements
      description: "Retrieves the list of `subscription_entitlements` for the [subscription](/docs/api/subscriptions).\
        \  \n**Note:**\n\nThe `components` attribute is not returned for any of the\
        \ `subscription_entitlements`. Use the retrieve operation(coming soon) to\
        \ obtain the `components`.\n"
      operationId: list_subscription_entitlements
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        subscription_entitlement:
                          $ref: "#/components/schemas/SubscriptionEntitlement"
                          description: Resource object representing subscription_entitlement
                      required:
                      - subscription_entitlement
                      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}/customer_entitlements:
    get:
      tags:
      - customers
      summary: List customer entitlements
      description: "**Tip**\n\nTo retrieve subscription entitlements for a specific\
        \ subscription, use the [List subscription entitlements API](/docs/api/subscription_entitlements/list-subscription-entitlements).\n\
        \nReturns a list of `customer_entitlement` objects for the specified customer.\
        \ The entitlements returned are for *active* subscriptions only. Specifically,\
        \ these are subscriptions with a [status](/docs/api/subscriptions/subscription-object#status)\
        \ of `active` or `non_renewing`.  \nPagination  \n[Pagination](/docs/api/list-ops#pagination)\
        \ works differently for this endpoint than other List endpoints in the Billing\
        \ API. In other list endpoints, the `limit` parameter sets the limit on the\
        \ total number of objects returned in the response. However, in this endpoint,\
        \ the `limit` parameter defines the number of features for which the `customer_entitlement`\
        \ objects are returned. For example, if `limit` = n, then all `customer_entitlement`\
        \ objects for up to n features are returned.\n\nLet's look at an example:\n\
        \n#### Features {#pagination-content}\n\nConsider the following three features\
        \ defined in Chargebee for a project management software:\n\n* User Licenses\n\
        * Support Level\n* Xero Integration\n\nThe `feature` objects are listed below:\n\
        \n##### Feature 1\n\n```js\n\n{\n    \"feature\": {\n        \"id\": \"user-licenses\"\
        ,\n        \"name\": \"User Licenses\",\n        \"description\": \"Maximum\
        \ number of user licenses allowed.\",\n        \"status\": \"active\",\n \
        \       \"type\": \"quantity\",\n        \"unit\": \"licence\",\n        \"\
        levels\": [\n            {\n                \"name\": \"3 licences\",\n  \
        \              \"value\": \"3\",\n                \"is_unlimited\": false,\n\
        \                \"level\": 1\n            },\n            {\n           \
        \     \"name\": \"10 licences\",\n                \"value\": \"10\",\n   \
        \             \"is_unlimited\": false,\n                \"level\": 2\n   \
        \         },\n            {\n                \"name\": \"25 licences\",\n\
        \                \"value\": \"25\",\n                \"is_unlimited\": false,\n\
        \                \"level\": 3\n            },\n            {\n           \
        \     \"name\": \"Unlimited licence\",\n                \"value\": \"Unlimited\"\
        ,\n                \"is_unlimited\": true,\n                \"level\": 4\n\
        \            }\n        ],\n        \"object\": \"feature\"\n    }\n}\n\n\
        ```\n\n##### Feature 2\n\n```js\n\n{\n    \"feature\": {\n        \"id\":\
        \ \"support-level\",\n        \"name\": \"Support Level\",\n        \"description\"\
        : \"Level of support offered.\",\n        \"status\": \"active\",\n      \
        \  \"type\": \"custom\",\n        \"levels\": [\n            {\n         \
        \       \"name\": \"Email\",\n                \"value\": \"Email\",\n    \
        \            \"is_unlimited\": false,\n                \"level\": 1\n    \
        \        },\n            {\n                \"name\": \"Chat\",\n        \
        \        \"value\": \"Chat\",\n                \"is_unlimited\": false,\n\
        \                \"level\": 2\n            },\n            {\n           \
        \     \"name\": \"Calls\",\n                \"value\": \"Calls\",\n      \
        \          \"is_unlimited\": false,\n                \"level\": 3\n      \
        \      }\n        ],\n        \"object\": \"feature\"\n    }\n}\n\n```\n\n\
        ##### Feature 3\n\n```js\n\n{\n    \"feature\": {\n        \"id\": \"xero-integration\"\
        ,\n        \"name\": \"Xero Integration\",\n        \"description\": \"Integrate\
        \ your Chargebee site with Xero\",\n        \"status\": \"active\",\n    \
        \    \"type\": \"switch\",\n        \"object\": \"feature\"\n    }\n}\n\n\
        ```\n\n##### Subscriptions\n\nNow consider that a customer `c1` has two subscriptions:\
        \ `s1` and `s2`.\n\n##### Subscription entitlements\n\nConsider the following\
        \ subscription entitlements for `s1` and `s2`:  \n\n| Subscription id |  \
        \  Feature Name    | Entitlement Value |\n|-----------------|--------------------|-------------------|\n\
        | `s1`            | `User Licenses`    | `3`               |\n| `s1`     \
        \       | `Support Level`    | `Email`           |\n| `s2`            | `User\
        \ Licenses`    | `10`              |\n| `s2`            | `Support Level`\
        \    | `Chat`            |\n| `s2`            | `Xero Integration` | `true`\
        \            |\n\n##### API responses\n\nAPI calls to this endpoint work as\
        \ follows:\n\n###### First call\n\nConsider the first call with `limit` set\
        \ to `2`.\n\n```js\n\nGET /api/v2/customers/c1/customer_entitlements?limit=2\n\
        \n```\n\n###### Response\n\n```js\n\n{\n    \"list\": [\n        {\n     \
        \       \"customer_entitlement\": {\n                \"customer_id\": \"c1\"\
        ,\n                \"subscription_id\": \"s1\",\n                \"feature_id\"\
        : \"user-licenses\",\n                \"value\": \"3\",\n                \"\
        name\": \"3 licences\",\n                \"is_enabled\": true,\n         \
        \       \"object\": \"customer_entitlement\"\n            }\n        },\n\
        \        {\n            \"customer_entitlement\": {\n                \"customer_id\"\
        : \"c1\",\n                \"subscription_id\": \"s2\",\n                \"\
        feature_id\": \"xero-integration\",\n                \"value\": \"true\",\n\
        \                \"name\": \"Available\",\n                \"is_enabled\"\
        : true,\n                \"object\": \"customer_entitlement\"\n          \
        \  }\n        },\n        {\n            \"customer_entitlement\": {\n   \
        \             \"customer_id\": \"c1\",\n                \"subscription_id\"\
        : \"s2\",\n                \"feature_id\": \"user-licenses\",\n          \
        \      \"value\": \"10\",\n                \"name\": \"10 licences\",\n  \
        \              \"is_enabled\": true,\n                \"object\": \"customer_entitlement\"\
        \n            }\n        }\n    ],\n    \"next_offset\": \"2\"\n}\n\n```\n\
        \nSince `limit` = `2`, the API returns the `customer_entitlement` for two\
        \ features: **User Licenses** and **Xero Integration**. Three objects are\
        \ returned, corresponding to rows 1, 3, and 5 in the table above.\n\n######\
        \ Second call\n\nWe now retrieve the next page of the list in the second call\
        \ by setting `offset` to the value of `next_offset` obtained from the previous\
        \ response.\n\n```js\n\n    GET /api/v2/customers/c1/customer_entitlements?limit=2&offset=2\n\
        \n```\n\n###### Response\n\n```js\n\n{\n    \"list\": [\n        {\n     \
        \       \"customer_entitlement\": {\n                \"customer_id\": \"c1\"\
        ,\n                \"subscription_id\": \"s1\",\n                \"feature_id\"\
        : \"support-level\",\n                \"value\": \"Email\",\n            \
        \    \"name\": \"Email\",\n                \"is_enabled\": true,\n       \
        \         \"object\": \"customer_entitlement\"\n            }\n        },\n\
        \        {\n            \"customer_entitlement\": {\n                \"customer_id\"\
        : \"c1\",\n                \"subscription_id\": \"s2\",\n                \"\
        feature_id\": \"support-level\",\n                \"value\": \"Chat\",\n \
        \               \"name\": \"Chat\",\n                \"is_enabled\": true,\n\
        \                \"object\": \"customer_entitlement\"\n            }\n   \
        \     }\n    ]\n}\n\n```\n\nAlthough `limit` = `2`, the `customer_entitlement`\
        \ objects for only one more feature, namely, Support Level are returned because\
        \ the remaining were covered in the previous page. No more `customer_entitlement`\
        \ objects remain for the customer, as indicated by the absence of the `next_offset`\
        \ attribute in the response. The returned objects in this last call correspond\
        \ to rows 2 and 4 in the table above.\n"
      operationId: list_customer_entitlements
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
      - name: limit
        in: query
        description: "The number of features for which to return `customer_entitlement`\n\
          objects.  \n**See also**\n[Pagination for List customer entitlements](/docs/api/customer_entitlements).\n"
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: consolidate_entitlements
        in: query
        description: |
          When set to `true`
          , the response returns a unified view of entitlement values for each feature across the customer. This includes entitlements assigned directly to the customer as well as those inherited from any of the customer's subscriptions. In this mode, the `subscription_id`
          field is omitted from the response objects. The consolidated entitlement value is derived using the same logic described in the [Subscription Entitlements documentation](/docs/api/subscription_entitlements)
          , based on the feature type.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          deprecated: false
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        customer_entitlement:
                          $ref: "#/components/schemas/CustomerEntitlement"
                          description: Resource object representing customer_entitlement
                      required:
                      - customer_entitlement
                      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: []
  /features/{feature-id}/item_entitlements:
    get:
      tags:
      - features
      summary: List item entitlements for a feature
      description: |
        **Deprecated**
        This operation is deprecated and no longer maintained. Migrate your integration to [List entitlements](/docs/api/entitlements/list-all-entitlements).

        Retrieves a list of all the `item_entitlement`
        s for the `feature`
        specified.
      operationId: list_item_entitlements_for_a_feature
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: feature-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/feature-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        item_entitlement:
                          $ref: "#/components/schemas/ItemEntitlement"
                          description: Resource object representing item_entitlement
                      required:
                      - item_entitlement
                      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:
      tags:
      - features
      summary: Upsert or remove item entitlements for a feature
      description: "**Deprecated**\nThis operation is deprecated and no longer maintained.\
        \ Migrate your integration to [Manage entitlements](/docs/api/entitlements/upsert-or-remove-entitlements-for-a-feature).\
        \  \n**Warning**\nThis operation is not supported when [grandfathering](/docs/api/entitlements)\
        \ is enabled.\n\nUpserts or removes a set of `item_entitlement`s for an `feature`\
        \ depending on the `action` specified. The API returns the upserted or deleted\
        \ `item_entitlements` after successfully completing the operation. The operation\
        \ returns an error when the first `item_entitlement` fails to be processed.\
        \ Either all the `item_entitlement`s provided in the request are processed\
        \ or none.\n"
      operationId: upsert_or_remove_item_entitlements_for_a_feature
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: feature-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/feature-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                action:
                  type: string
                  deprecated: false
                  description: |
                    The specific action to be performed for each `item_entitlement`
                    specified.

                    * remove -
                      Deletes the `item_entitlement`
                      for the `feature_id`
                      and `item_id`
                      combination, if it exists.
                    * upsert -
                      If the `item_entitlement`
                      already exists for the `feature_id`
                      and `item_id`
                      combination, the `value`
                      of the `item_entitlement`
                      is updated. If it doesn't exist, a new `item_entitelment`
                      is created.
                  enum:
                  - upsert
                  - remove
                  example: null
                item_entitlements:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_entitlements
                  properties:
                    item_id:
                      type: array
                      description: |
                        The `id`
                        of the `item`
                        to which this entitlement belongs.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    item_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The `type`
                          of the `item`
                          to which this entitlement belongs.

                          * plan - Plan
                          * item - Item
                          * subscription - Subscription
                          * addon - Addon
                          * charge - Charge
                        enum:
                        - plan
                        - addon
                        - charge
                        - subscription
                        - item
                        example: null
                      example: null
                    value:
                      type: array
                      description: |+
                        The level of entitlement that the item has towards the feature. The possible values depend on the value of `feature.type`
                        :

                        * When `feature.type` is `quantity` and:

                        * If `feature.levels[is_unlimited]` is not `true` for any one of `feature.levels[]`, then the value can be any one of `feature.levels[value][]`.

                        * If `feature.levels[is_unlimited]` is `true` for one of the `feature.levels[]`, then the value can also be:

                          * any one of `feature.levels[value][]`
                          * or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.
                        * When `type` is `range` and:

                        * If `feature.levels[is_unlimited]` is not `true` for any one of `feature.levels[]`, then the value can be any whole number between `levels[value][0]` and `levels[value][1]` (inclusive).

                        * If `feature.levels[is_unlimited]` is `true` for one of the `feature.levels[]`, then the value can be:

                          * any whole number equal to or greater than `levels[value][0]`
                          * or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.
                        * When `type` is `custom`, then the value can be any one of `feature.levels[value][]`.

                        * When `type` is `switch`, then the value is set as `available` or `true`.

                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  required:
                  - item_id
                  example: null
              required:
              - action
              example: null
            encoding:
              item_entitlements:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        item_entitlement:
                          $ref: "#/components/schemas/ItemEntitlement"
                          description: Resource object representing item_entitlement
                      required:
                      - item_entitlement
                      example: null
                    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: []
  /items/{item-id}/item_entitlements:
    get:
      tags:
      - items
      summary: List item entitlements for an item
      description: |
        **Deprecated**
        This operation is deprecated and no longer maintained. Migrate your integration to [List entitlements](/docs/api/entitlements/list-all-entitlements).

        Retrieves a list of all the `item_entitlements`
        for the `item`
        specified.
      operationId: list_item_entitlements_for_an_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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: item-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/item-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        item_entitlement:
                          $ref: "#/components/schemas/ItemEntitlement"
                          description: Resource object representing item_entitlement
                      required:
                      - item_entitlement
                      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:
      tags:
      - items
      summary: Upsert or remove item entitlements for an item
      description: "**Deprecated**\nThis operation is deprecated and no longer maintained.\
        \ Migrate your integration to [Manage entitlements](/docs/api/entitlements/upsert-or-remove-entitlements-for-a-feature).\
        \  \n**Warning**\nThis operation is not supported when [grandfathering](/docs/api/entitlements)\
        \ is enabled.\n\nUpserts or removes a set of `item_entitlements` for an [item](/docs/api/items)\
        \ depending on the `action` specified. The API returns the upserted or deleted\
        \ `item_entitlements` after successfully completing the operation. The operation\
        \ returns an error when the first `item_entitlement` fails to be processed.\
        \ Either all the `item_entitlement`s provided in the request are processed\
        \ or none.\n"
      operationId: upsert_or_remove_item_entitlements_for_an_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: item-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/item-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                action:
                  type: string
                  deprecated: false
                  description: |
                    The specific action to be performed for each `item_entitlement`
                    specified.

                    * remove -
                      Deletes the `item_entitlement`
                      for the `feature_id`
                      and `item_id`
                      combination, if it exists.
                    * upsert -
                      If the `item_entitlement`
                      already exists for the `feature_id`
                      and `item_id`
                      combination, the `value`
                      of the `item_entitlement`
                      is updated. If it doesn't exist, a new `item_entitelment`
                      is created.
                  enum:
                  - upsert
                  - remove
                  example: null
                item_entitlements:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_entitlements
                  properties:
                    feature_id:
                      type: array
                      description: |
                        The `id`
                        of the feature towards which this entitlement has been granted.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    value:
                      type: array
                      description: |+
                        The level of entitlement that the item has towards the feature. The possible values depend on the value of `feature.type`
                        :

                        * When `feature.type` is `quantity` and:

                        * If `feature.levels[is_unlimited]` is not `true` for any one of `feature.levels[]`, then the value can be any one of `feature.levels[value][]`.

                        * If `feature.levels[is_unlimited]` is `true` for one of the `feature.levels[]`, then the value can also be:

                          * any one of `feature.levels[value][]`
                          * or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.
                        * When `type` is `range` and:

                        * If `feature.levels[is_unlimited]` is not `true` for any one of `feature.levels[]`, then the value can be any whole number between `levels[value][0]` and `levels[value][1]` (inclusive).

                        * If `feature.levels[is_unlimited]` is `true` for one of the `feature.levels[]`, then the value can be:

                          * any whole number equal to or greater than `levels[value][0]`
                          * or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.
                        * When `type` is `custom`, then the value can be any one of `feature.levels[value][]`.

                        * When `type` is `switch`, then the value is set as `available` or `true`.

                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  required:
                  - feature_id
                  example: null
              required:
              - action
              example: null
            encoding:
              item_entitlements:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        item_entitlement:
                          $ref: "#/components/schemas/ItemEntitlement"
                          description: Resource object representing item_entitlement
                      required:
                      - item_entitlement
                      example: null
                    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: []
  /entitlements:
    get:
      tags:
      - entitlements
      summary: List entitlements
      description: |
        Retrieves a list of all the `entitlement`s associated with the specified `feature`.
      operationId: list_all_entitlements
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: feature_id
        in: query
        description: |
          optional, string filter

          The `id`
          of the feature associated with this entitlement.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *feature_id\[is\] = "user-licenses"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: user-licenses
          properties:
            in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
            is:
              type: string
              minLength: 1
              example: null
      - name: entity_type
        in: query
        description: |
          optional, enumerated string filter

          The `type`
          of the `entity`
          to which this entitlement belongs. Possible values are : plan, addon, charge, plan_price, addon_price.

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

          **Example →**
          *entity_type\[in\] = "plan_price"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: plan_price
          properties:
            in:
              type: string
              description: |-
                * `plan` - Plan
                * `addon` - Addon
                * `charge` - Charge
                * `plan_price` - Plan Price
                * `addon_price` - Addon Price
              enum:
              - plan
              - addon
              - charge
              - plan_price
              - addon_price
              pattern: "^\\[(plan|addon|charge|plan_price|addon_price)(,(plan|addon|charge|plan_price|addon_price))*\\\
                ]$"
              example: null
            is:
              type: string
              description: |-
                * `plan` - Plan
                * `addon` - Addon
                * `charge` - Charge
                * `plan_price` - Plan Price
                * `addon_price` - Addon Price
              enum:
              - plan
              - addon
              - charge
              - plan_price
              - addon_price
              example: null
      - name: entity_id
        in: query
        description: |
          optional, string filter

          The `id`
          of the `entity`
          to which this entitlement belongs. .
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *entity_id\[in\] = "usd-professional-monthly"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: usd-professional-monthly
          properties:
            in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
            is:
              type: string
              minLength: 1
              example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        entitlement:
                          $ref: "#/components/schemas/Entitlement"
                          description: Resource object representing entitlement
                      required:
                      - entitlement
                      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:
      tags:
      - entitlements
      summary: Manage entitlements for a feature
      description: |
        Create, update, or remove a set of `entitlement`s for a feature.

        The behavior depends on the specified `action`. It tries to create, update, or delete `entitlement` objects. If any of the entitlement objects fail to process, the entire operation stops with an error, and no entitlements are processed. In essence, the request processes either all the provided entitlements or none of them.

        ### Grandfathering in entitlements {#grandfathering}

        > **Early Access**
        >
        > Grandfathering in entitlements is in early access. Write to [eap@chargebee.com](mailto:eap@chargebee.com) to get this enabled.

        By default, this operation impacts all [subscriptions](/docs/api/subscriptions) that contain the item or item price. However, if you set `apply_grandfathering` to `true`, the existing subscriptions are not impacted by the change.

        #### Example

        Consider the following example:

        ##### On January 1st

        * You have a [plan price](/docs/api/item_prices/item_price-object#item_type) (`id`: `premium-monthly-usd`) entitled to a [feature](/docs/api/features) (`user_licenses`) at [value](/docs/api/features/feature-object#levels) `10`.
        * You have a subscription (`id`: `AzZjAiTl1btqS2lEj`) that contains the plan price (`premium-monthly-usd`).

        ##### On January 2nd

        * Using this API operation, you change the entitlement level of the plan price `premium-monthly-usd` for the `user_licenses` feature to `value` `20`. You also set `apply_grandfathering` to `true`.
        * After the API operation completes, you [create a new subscription](/docs/api/subscriptions/create-subscription-for-items) (`id`: `6oqNGUlMd9Yn4Ui`) that contains the same plan price (`premium-monthly-usd`).
        * The existing subscription (`id`: `AzZjAiTl1btqS2lEj`) is [grandfathered in](https://en.wikipedia.org/wiki/Grandfather_clause), so it continues to be entitled to `user_licenses` at `value` `10`. The new subscription (`id`: `6oqNGUlMd9Yn4Ui`) is entitled to `user_licenses` at `value` `20`.

        ##### On January 3rd

        * Using this API operation, you change the entitlement level of the plan price `premium-monthly-usd` for the `user_licenses` feature to `value` `30`. You also set `apply_grandfathering` to `false`.
        * After the API operation completes, you create another subscription (`id`: `99CRh8UgMXTq77tl`) that contains the same plan price (`premium-monthly-usd`).
        * Because grandfathering was not enabled, all three subscriptions (`AzZjAiTl1btqS2lEj`, `6oqNGUlMd9Yn4Ui`, and `99CRh8UgMXTq77tl`) are now entitled to `user_licenses` at `value` `30`.
      operationId: upsert_or_remove_entitlements_for_a_feature
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                action:
                  type: string
                  deprecated: false
                  description: |
                    The specific action to be performed for each `entitlement`
                    specified.

                    * upsert -
                      If the `entitlement`
                      already exists for the `feature_id`
                      and `entity_id`
                      combination, the `value`
                      of the `entitlement`
                      is updated. If it doesn't exist, a new `entitlement`
                      is created.
                    * remove -
                      Deletes the `entitlement`
                      for the `feature_id`
                      and `entity_id`
                      combination, if it exists.
                  enum:
                  - upsert
                  - remove
                  example: null
                change_reason:
                  type: string
                  deprecated: false
                  description: |
                    Comments or reason for this entitlement change.
                  maxLength: 100
                  example: null
                entitlements:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for entitlements
                  properties:
                    entity_id:
                      type: array
                      description: "The unique identifier of the entity being granted\
                        \ entitlement to a specific `feature`.  \n**Note**\nIn the\
                        \ case of an `upsert` `action`, if the `entitlement` resource\
                        \ does not already exist, Chargebee does not validate this\
                        \ ID to confirm its correspondence to an existing entity.\
                        \ The `entitlement` is created regardless.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    feature_id:
                      type: array
                      description: |
                        The unique identifier of the `feature` to which the entity gains entitlement.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    entity_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The type of the entity that holds this entitlement.

                          * plan - Indicates that the entity is an `item` with [type](/docs/api/items/item-object#type) set to `plan`.
                          * addon_price - Indicates that the entity is an `item_price` associated with an `item` with [type](/docs/api/items/item-object#type) set to `addon`.
                          * charge -
                            Indicates that the entity is an `item`
                            with [type](/docs/api/items/item-object#type)
                            set to `charge`
                            .
                          * addon - Indicates that the entity is an `item` with [type](/docs/api/items/item-object#type) set to `addon`.
                          * plan_price - Indicates that the entity is an `item_price` associated with an `item` of [type](/docs/api/items/item-object#type) `plan`.
                        enum:
                        - plan
                        - addon
                        - charge
                        - plan_price
                        - addon_price
                        example: null
                      example: null
                    value:
                      type: array
                      description: |+
                        The level of entitlement that the entity has towards the feature. The possible values depend on the value of `feature.type`
                        :

                        * When `feature.type` is `quantity` and:

                        * If `feature.levels[is_unlimited]` is not `true` for any one of `feature.levels[]`, then the value can be any one of `feature.levels[value][]`.

                        * If `feature.levels[is_unlimited]` is `true` for one of the `feature.levels[]`, then the value can be:

                          * any one of `feature.levels[value][]`
                          * or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.
                        * When `type` is `range` and:

                        * If `feature.levels[is_unlimited]` is not `true` for any one of `feature.levels[]`, then the value can be any whole number between `levels[value][0]` and `levels[value][1]` (inclusive).

                        * If `feature.levels[is_unlimited]` is `true` for one of the `feature.levels[]`, then the value can be:

                          * any whole number equal to or greater than `levels[value][0]`
                          * or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.
                        * When `type` is `custom`, then the value can be any one of `feature.levels[value][]`.

                        * When `type` is `switch`, then the value is set as `available` or `true`.

                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    apply_grandfathering:
                      type: array
                      description: |
                        **Early Access**

                        [Grandfathering support](/docs/api/entitlements) for entitlements is in early access. Write to [eap@chargebee.com](mailto:eap@chargebee.com) to get this enabled.

                        Determines whether to [grandfather in](/docs/api/entitlements) existing subscriptions affected by this entitlement.

                        * `true`: Existing subscriptions that contain this entity as one of the [subscription items](/docs/api/subscriptions/subscription-object#subscription_items), are not mapped to this value of the entitlement; their currently mapped value for this entitlement are retained. New subscriptions created in the future that contain this entity, or existing subscriptions updated in the future to include this entity, are mapped to this value of the entitlement.
                        * `false`: All subscriptions that contain this entity are mapped to this version of the entitlement.
                      items:
                        type: boolean
                        default: false
                        deprecated: false
                        example: null
                      example: null
                  required:
                  - entity_id
                  - feature_id
                  example: null
              required:
              - action
              example: null
            encoding:
              entitlements:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        entitlement:
                          $ref: "#/components/schemas/Entitlement"
                          description: Resource object representing entitlement
                      required:
                      - entitlement
                      example: null
                    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: []
  /in_app_subscriptions/{in-app-subscription-app-id}/retrieve:
    post:
      tags:
      - in_app_subscriptions
      summary: Retrieve store subscription
      description: "This API verifies the application id `{in_app_subscription_app_id}`\
        \ and `receipt` then returns the subscription details associated with the\
        \ purchase.\n\n#### Path Parameter\n\nin_app_subscription_app_id  \nrequired,\
        \ string\n\nThe handle is created by Chargebee for your Apple App Store or\
        \ Google Play Store app. It can be obtained from the Chargebee web app.\n\
        The following are instructions to obtain the value of the path parameter for\
        \ the Apple App Store and Google Play Store.\n\n* **Apple App Store** : To\
        \ obtain the value for `{in_app_subscription_app_id}`, click **View Keys**\
        \ within the **Sync Overview** page of the web app and use the value of generated\
        \ **App ID** for this parameter. See detailed steps [here](https://www.chargebee.com/docs/1.0/mobile-app-store-product-iap.html#resource-id).\n\
        * **Google Play Store** : To obtain the value for `{in_app_subscription_app_id}`,\
        \ click **Set up notifications** within the **Sync Overview** page of the\
        \ web app and use the value of generated **App ID** for this parameter. See\
        \ detailed steps [here](https://www.chargebee.com/docs/1.0/mobile-playstore-notifications.html#app-id).\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    **Apple App Store** : The Base64 encoded [App Store in-app purchase receipt](https://developer.apple.com/documentation/storekit/original_api_for_in-app_purchase/validating_receipts_with_the_app_store?language=objc#overview) taken from the Apple device after successful creation of the in-app purchase subscription.
                    **Google Play Store** : The purchase `token` taken from the Android device after the successful creation of an in-app purchase subscription.
                  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: |
                      Array of in_app_subscription object
                    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:
      tags:
      - in_app_subscriptions
      summary: Import receipt
      description: "Verifies an Apple App Store or Google Play Store in-app purchase\
        \ [receipt](https://developer.apple.com/documentation/storekit/original_api_for_in-app_purchase/validating_receipts_with_the_app_store?language=objc#overview)\
        \ and imports [subscriptions](/docs/api/subscriptions) for all historical\
        \ purchases made by the customer.  \n**Tip**\nAn `in_app_subscription`\nis\
        \ created for every unique `original_transaction_id`\n. Apple creates `original_transaction_id`\n\
        for every create, upgrade, or downgrade of the subscription. A receipt hardly\
        \ contains more than 100 `original_transaction_id`\ns. If a receipt contains\
        \ more than 100 `original_transaction_id`\ns, Chargebee creates all subscription\
        \ records but this endpoint returns the first 100 records in the response.\n\
        \nCSV upload has a file size [limitation](https://www.chargebee.com/docs/mobile-app-store-product-iap.html#upload-in-app-receipts)\
        \ 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.  \n**Note**\n: This API verifies receipt or token through Apple\
        \ or Google and then processes them via Chargebee. For bulk imports, limit\
        \ API calls to **6**\nper minute (**10**\nseconds apart) to ensure successful\
        \ subscription imports.  \nApple App Store  \nThis section provides details\
        \ of the Import Receipt operation performed for the Apple App Store. This\
        \ API processes only the historical in-app transaction receipts.  \n**Important**\n\
        \n* [Integrate Chargebee](https://www.chargebee.com/docs/mobile-app-store-connect.html#connnect-with-your-chargebee-site)\
        \ with your Apple App Store account using your shared secret from Apple.\n\
        * It is strongly recommended to use this endpoint to import historical in-app\
        \ subscriptions only.\n* You must [import Apple App Store products](https://www.chargebee.com/docs/2.0/mobile-app-store-product-iap.html#import-products)\
        \ using Chargebee's user interface before importing receipts using this API.\n\
        \nChargebee validates the `receipt` with Apple App Store and does the following\
        \ once validation succeeds:\n\n#### Subscriptions {#apple-app-store-accordion-content}\n\
        \n[Subscriptions](/docs/api/subscriptions) are imported as follows:\n\n1.\
        \ A subscription is imported for every unique value of the [original_transaction_id](https://developer.apple.com/documentation/appstorereceipts/original_transaction_id?language=objc)\
        \ in the Apple receipt. **Note** : This is not done for `original_transaction_id`s\
        \ for which a subscription already exists in Chargebee.\n2. Each subscription\
        \ imported has the following attributes set:\n   * `id` set to `original_transaction_id`.\n\
        \   * `start_date` set to the earliest [purchase_date_ms](https://developer.apple.com/documentation/appstorereceipts/responsebody/latest_receipt_info?language=objc).\n\
        \   * `current_term_start` set to latest [purchase_date_ms](https://developer.apple.com/documentation/appstorereceipts/responsebody/latest_receipt_info?language=objc).\n\
        \   * `current_term_end` set to [expires_date_ms](https://developer.apple.com/documentation/appstorereceipts/responsebody/latest_receipt_info?language=objc)\
        \ of the same `Latest_receipt_info` element with the latest `purchase_date_ms`.\n\
        \   * `item_price_id` set to `product_id`.\n   * `status` set to `in_trial`\
        \ if there is only one element of [Latest_receipt_info](https://developer.apple.com/documentation/appstorereceipts/responsebody/latest_receipt_info?language=objc)\
        \ with the `original_transaction_id` and the field `is_trial_period` is `true`,\
        \ then consider the subscription is currently in trial. No invoices are created\
        \ for this subscription.\n\n#### Invoices for the subscription\n\n[Invoices](/docs/api/invoices)\
        \ are imported as follows:\n\n1. An invoice is imported to Chargebee for every\
        \ element of the array [Latest_receipt_info](https://developer.apple.com/documentation/appstorereceipts/responsebody/latest_receipt_info?language=objc)\
        \ which has [is_trial_period](https://developer.apple.com/documentation/appstorereceipts/is_trial_period?language=objc)\
        \ as `false`.\n2. Each imported invoice has the `subscription_id` set to `original_transaction_id`.\n\
        \n#### Transactions for the invoices\n\nA [transaction](/docs/api/transactions)\
        \ is imported for each invoice with the following details:\n\n1. `reference_number`\
        \ set to the `transaction_id`.\n2. `payment_method` set to `apple_store`.\
        \  \nGoogle Play Store  \nThis 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.  \n**Important**\n\n\
        * [Integrate Chargebee](https://www.chargebee.com/docs/2.0/mobile-playstore-connect.html)\
        \ with your Google Play Store account using your [service account credentials\
        \ JSON](https://www.chargebee.com/docs/2.0/mobile-playstore-connect.html#generate-service-account-credentials-json).\n\
        * It is strongly recommended to use this endpoint to import historical in-app\
        \ subscriptions only.\n* It is recommended to pass only the latest purchase\
        \ `token`. If any other purchase `token` is passed instead of the latest one,\
        \ there is a possibility of returning incorrect transaction details. If an\
        \ expired purchase `token` is passed, then it returns an error.\n* The Google\
        \ purchase token is [valid from subscription signup until 60 days](https://developer.android.com/google/play/billing/lifecycle/subscriptions)\
        \ after subscription expiration. After the `token` expires, an API request\
        \ to Google Developers API returns an error.\n\nChargebee validates the purchase\
        \ `token` with Google Play Store and does the following once validation succeeds:\n\
        \n#### Subscriptions {#google-play-store-accordion-content}\n\n* A [subscription](/docs/api/subscriptions)\
        \ is imported for every unique purchase token if it is not linked to an existing\
        \ purchase `token`( `linkedPurchaseToken` field in `SubscriptionsV2.get` API\
        \ Response).\n\n* Each subscription imported has the following attributes\
        \ set:\n\n  * `id` set to a unique identifier generated by Chargebee and mapped\
        \ to the `token` and `latestOrderId` of the `SubscriptionPurchaseV2` object\
        \ from Google response.\n\n  * `start_date` set to the earliest `SubscriptionPurchaseV2.startTime`.\n\
        \n  * `current_term_start` set to latest `SubscriptionPurchaseV2.startTime`.\n\
        \n  * `current_term_end` set to `expiryTime` of the same `SubscriptionPurchaseV2`\
        \ element with the latest purchase.\n\n  * `item_price_id` set to the concatenation\
        \ of `product[id]` and `priceCurrencyCode` from Google.\n\n  * `status` set\
        \ to `in_trial` if the free trial configuration is enabled in Google and the\
        \ [monetization.subscriptions.basePlans.offers.State](https://developers.google.com/android-publisher/api-ref/rest/v3/monetization.subscriptions.basePlans.offers#State)\
        \ is `Active` with a [SubscriptionOfferPhase.duration](https://developers.google.com/android-publisher/api-ref/rest/v3/monetization.subscriptions.basePlans.offers#subscriptionofferphase),\
        \ then consider the subscription is currently in trial. No invoices are created\
        \ for this subscription.\n\n#### Invoices for the subscription\n\nInvoices\
        \ are imported as follows:\n\n* An [invoice](/docs/api/invoices) is imported\
        \ to Chargebee for every new subscription and renewal of an existing subscription\
        \ using `latestOrderId`.\n\n* Each imported invoice has the `subscription_id`\
        \ set to a unique identifier generated by Chargebee and mapped to the `token`\
        \ and `latestOrderId`.\n\n#### Transactions for the invoices\n\nA [transaction](/docs/api/transactions)\
        \ is imported for each invoice with the following details:\n\n* `transaction.reference_number`\
        \ is set to the `latestOrderId`.\n\n* `transaction.payment_method` is set\
        \ to `play_store`.\n\nPath Parameter\n--------------\n\n`{in_app_subscription_app_id}`:\
        \ The handle created by Chargebee for your Apple App Store or Google Play\
        \ Store app. It can be obtained from the Chargebee web app.\nThe following\
        \ are instructions to obtain the value of the path parameter for the Apple\
        \ App Store and Google Play Store.\n\n* **Apple App Store** : To obtain the\
        \ value for `{in_app_subscription_app_id}`, click **View Keys** within the\
        \ **Sync Overview** page of the web app and use the value of generated **App\
        \ ID** for this parameter. See detailed steps [here](https://www.chargebee.com/docs/1.0/mobile-app-store-product-iap.html#connection-keys_app-id).\n\
        * **Google Play Store** : To obtain the value for `{in_app_subscription_app_id}`,\
        \ click **Set up notifications** within the **Sync Overview** page of the\
        \ web app and use the value of generated **App ID** for this parameter. See\
        \ detailed steps [here](https://www.chargebee.com/docs/1.0/mobile-playstore-notifications.html#app-id).\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    **Apple App Store** : The Base64 encoded [App Store in-app purchase receipt](https://developer.apple.com/documentation/storekit/original_api_for_in-app_purchase/validating_receipts_with_the_app_store?language=objc#overview) taken from the Apple device after successful creation of the in-app purchase subscription.
                    **Google Play Store** : The purchase `token` taken from the Android device after the successful creation of an in-app purchase subscription.
                  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: |
                        **Apple App Store** : The unique `id` in Chargebee for the customer who made this purchase. If not provided, the value is considered to be `original_transaction_id` (the transaction identifier at Apple, of the original purchase). If the customer record is not found in Chargebee, it is created.
                        **Google Play Store** : The unique `id` of the customer who made this purchase via Google Play Store. This unique `id` will be used as customer ID within Chargebee. If not provided, `subscription_id` (random unique `id`) will be the customer ID. If the customer ID already exists in Chargebee then subscription will be associated with this customer ID.
                      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: |
                      Array of in_app_subscription object
                    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:
      tags:
      - in_app_subscriptions
      summary: Import subscription without receipt
      description: "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 [Import Receipt](/docs/api/in_app_subscriptions/import-receipt)\
        \ API.\nWith this API, you can import subscriptions and corresponding invoices\
        \ for historic In-App purchases. The API returns the [in-app-subscriptions\
        \ object](/docs/api/in_app_subscriptions/in-app-subscription-object) once\
        \ the historic subscription is successfully imported into Chargebee.  \n**Note**:\n\
        \n* 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.\n* Enable V1 notifications in the Apple App Store\
        \ for subscriptions created without receipts. Chargebee depends on receipt\
        \ data to update subscription statuses. Apple's V2 notifications do not have\
        \ receipt information; therefore, Chargebee cannot process V2 notifications\
        \ for subscriptions imported without receipts. Learn more about [app store\
        \ notifications](/docs/api/in_app_purchase_events) and [notification URL configuration](https://www.chargebee.com/docs/mobile-app-store-product-iap.html#connection-keys_notification-url).\n\
        \n### Apple App Store\n\nThis 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.  \n**Important**\n\n* [Integrate\
        \ Chargebee](https://www.chargebee.com/docs/mobile-app-store-connect.html#connnect-with-your-chargebee-site)\
        \ with your Apple App Store account using your shared secret from Apple.\n\
        \n* It is strongly recommended to use this endpoint to create a historic In-App\
        \ subscription only.\n\n* You must import App Store products using Chargebee's\
        \ user interface before importing receipts using this API.\n\nChargebee validates\
        \ the application ID with Apple App Store and does the following once validation\
        \ succeeds:\n\n#### Subscription\n\n1. Import the subscription from the `latest_receipt_info`\
        \ array from Apple and a new subscription is imported for the item-price.\n\
        \n   **Note:** 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.\n\n2. Each subscription imported has the following attribute\
        \ set:\n\n   * `id` set to `subscription[id]` . This `subscription[id]` is\
        \ `original_transaction_id` in the receipts.\n\n   * `start_date` set to `subscription[start_date]`.\
        \ You need to provide this information from the oldest `Latest_receipt_info.purchase_date_ms`.\n\
        \n   * `term_start` set to `subscription[term_start]`. You need to provide\
        \ this information from the oldest `Latest_receipt_info.purchase_date_ms)`.\n\
        \n   * `term_end` set to `subscription[term_end]`. You need to provide this\
        \ information from the oldest `Latest_receipt_info.expires_date_ms`.\n\n \
        \  * `item_price_id` set to `subscription[product_id] + subscription[currency_code].`\
        \ You need to provide this information from the `Latest_receipt_info.product_id`.\n\
        \n   * Chargebee records the subscription in a **Trial** state if the `is_trial_period`\
        \ is `true`.\n\n   * Chargebee records the subscription in a **Canceled**\
        \ state if the `term_end` is less than the `System.currentTime()`.\n\n####\
        \ Invoice for the subscription\n\n1. The payment is recorded against the subscription\
        \ invoice.\n\n* Imported invoice has the `subscription_id` set to `original_transaction_id`.\
        \ **Transactions for the invoice**\n\n1. The associated transaction is updated\
        \ with the following details:\n\n* The `transaction.reference_number` is set\
        \ to the `transaction_id` of the payment.\n\n* The `transaction.payment_method`\
        \ is set to `apple_store`.\n\n#### Path Parameter\n\nin_app_subscription_app_id\
        \  \nrequired, string\n\nThe handle created by Chargebee for your App Store\
        \ app. It can be obtained from within the Chargebee web app. To obtain the\
        \ value of `in_app_subscription_app_id` for the Apple App Store, click **View\
        \ Keys** within the **Sync Overview** page of the web app, and use the value\
        \ of generated **App ID** for this parameter. See detailed steps [here](https://www.chargebee.com/docs/mobile-app-store-product-iap.html#connection-keys_app-id).\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                        This parameter is known as `original_transaction_id` in Apple App Store. You can get the value of `original_transaction_id` from the [`latest_receipt_info`](https://developer.apple.com/documentation/appstorereceipts/responsebody/latest_receipt_info). The `latest_receipt_info` is an array that contains all in-app purchase transactions.
                      maxLength: 50
                      example: null
                    started_at:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The time at which the subscription has started or going to be started. You can find this value from the oldest `purchase_date_ms`.
                      example: null
                    term_start:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        Start date of the billing period for the subscription. You can find it from the `purchase_date_ms` field in receipt payload.
                      example: null
                    term_end:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        End date of the billing period for the subscription. You can find it from the `expires_date_ms` field in receipt payload.
                      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: |
                        Transaction ID value as mentioned in the [`latest_receipt_info`](https://developer.apple.com/documentation/appstorereceipts/responsebody/latest_receipt_info).
                        This must be unique across subscriptions.
                      maxLength: 43
                      example: null
                    is_trial:
                      type: boolean
                      default: false
                      deprecated: false
                      description: |
                        Indicates if the subscription is in trial for the term start and term end. The default value is `false`
                        .
                      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: |
                        The unique [id](/docs/api/customers/create-a-customer#id) in Chargebee for the customer who made this purchase. If not provided, the value is considered to be [original_transaction_id](https://developer.apple.com/documentation/appstorereceipts/original_transaction_id?language=objc) (the transaction identifier at Apple, of the original purchase.). If the customer record is not found in Chargebee, it is created.
                      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: |
                      Resource object representing in_app_subscription
                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:
      tags:
      - in_app_subscriptions
      summary: Process purchase command
      description: "Verifies an in-app purchase made by your customer and creates\
        \ a subscription in Chargebee.  \n**Note:**\nIf 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 [import receipt](/docs/api/in_app_subscriptions/import-receipt)\
        \ API, importing products is mandatory. [Learn more](https://www.chargebee.com/docs/billing/2.0/mobile-subscriptions/mobile_subscriptions_manage).\
        \  \nApple App Store  \nThis 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 [bulk import](https://www.chargebee.com/docs/2.0/mobile-app-store-product-iap.html#import-in-app-purchase-receipts)\
        \ of In-App Purchase receipts.  \n**Important**\n\n* [Integrate Chargebee](https://www.chargebee.com/docs/mobile-app-store-connect.html#connnect-with-your-chargebee-site)\
        \ with your Apple App Store account using your shared secret from Apple.\n\
        * It is strongly recommended to use this endpoint to notify Chargebee of **new**\
        \ purchases only.\n* For updates to existing subscriptions, we recommend that\
        \ you configure Apple App Store to send server notifications to Chargebee.\n\
        \nChargebee validates the `receipt` with Apple App Store and does the following\
        \ once validation succeeds:\n\n1. Look for [item_family.id](/docs/api/item_families/item_family-object#id)\
        \ that matches the value Apple-App-Store, and create such a product family\
        \ if not found.\n2. Look for [item.id](/docs/api/items/item-object#id) that\
        \ matches `product[id]` and if not found, create such a plan-item under the\
        \ item family described in the previous step.\n3. Look for [item_price.id](/docs/api/item_prices/item_price-object#id)\
        \ that matches the concatenation of `product[id]` and `product[currency_code]`,\
        \ and if not found, create such an item price under the item described in\
        \ the previous step.\n4. Create/update a subscription:\n\n* If the receipt\
        \ is for a new purchase, a new subscription is created for the plan-item price\
        \ described in the previous step. The subscription has the following details:\n\
        \n* `id` set to [original_transaction_id](https://developer.apple.com/documentation/appstorereceipts/original_transaction_id?language=objc)\n\
        \n* `start_date` set to [responseBody.Latest_receipt_info.purchase_date_ms](https://developer.apple.com/documentation/appstorereceipts/responsebody/latest_receipt_info?language=objc)\n\
        \n* `current_term_end` set to `responseBody.Latest_receipt_info.expires_date_ms`\n\
        \n* Instead, if the receipt belongs to an existing subscription in Chargebee,\
        \ it is updated to reflect the current state of the subscription at Apple.\n\
        \n1. The payment is recorded against the subscription invoice. The associated\
        \ transaction is updated with the following details:\n\n* The [transaction.reference_number](/docs/api/transactions/transaction-object#reference_number)\
        \ is set to the [transaction_id](https://developer.apple.com/documentation/appstorereceipts/transaction_id?language=objc)\
        \ of the payment.\n* The [transaction.payment_method](/docs/api/transactions/transaction-object#payment_method)\
        \ is set to `apple_pay`.  \nGoogle Play Store  \nThis 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.  \n**Important**\n\n* [Integrate Chargebee](https://www.chargebee.com/docs/2.0/mobile-playstore-connect.html#chargebee-configuration)\
        \ with your Google Play Store account using the service account credentials\
        \ JSON.\n* It is strongly recommended to use this endpoint to notify Chargebee\
        \ of **new** purchases only.\n* For updates to existing subscriptions, we\
        \ recommend that you configure Chargebee to receive Google's server notifications\
        \ through pub/sub topic. [Learn more](https://developer.android.com/google/play/billing/getting-ready#setup-pubsub).\n\
        \nChargebee validates the purchase **token** with Google Play Store and does\
        \ the following once validation succeeds:\n\n1. Look for [item_family.id](/docs/api/item_families/item_family-object#id)\
        \ that matches the value `Google-Play-Store`, and create such a product family\
        \ if not found.\n2. Look for [item.id](/docs/api/items/item-object#id) that\
        \ matches `product[id]` and if not found, create such a [plan-item](/docs/api/items/item-object#type)\
        \ under the item family described in the previous step.\n3. Look for [item_price.id](/docs/api/item_prices/item_price-object#id)\
        \ that matches the concatenation of `product[id]` and [priceCurrencyCode](https://developers.google.com/android-publisher/api-ref/rest/v3/purchases.subscriptions?hl=en#SubscriptionPurchase.FIELDS.price_currency_code),\
        \ and if not found, create such an item price under the item described in\
        \ the previous step.\n4. Create/update a subscription:\n\n* If this token\
        \ is for a new purchase, a new subscription is created for the plan-item price\
        \ described in the previous step. The subscription has the following details:\n\
        \n* `id` set to unique identifier generated by Chargebee and mapped to **token**\
        \ of the [SubscriptionPurchase](https://developers.google.com/android-publisher/api-ref/rest/v3/purchases.subscriptions?hl=en)\
        \ object from Google response.\n\n* `start_date` set to `SubscriptionPurchase.startTimeMillis`.\n\
        \n* `current_term_end` set to `SubscriptionPurchase.expiryTimeMillis`.\n\n\
        * Instead, if the token belongs to an existing subscription in Chargebee,\
        \ it is updated to reflect the current state of the subscription at Google.\n\
        \n1. The payment is recorded against the subscription invoice. The associated\
        \ transaction is updated with the following details:\n\n* The [transaction.reference_number](/docs/api/transactions/transaction-object#reference_number)\
        \ is set to the [orderId](https://developers.google.com/android-publisher/api-ref/rest/v3/purchases.subscriptions?hl=en#SubscriptionPurchase.FIELDS.order_id)\
        \ of the payment.\n* The [transaction.payment_method](/docs/api/transactions/transaction-object#payment_method)\
        \ is set to `play_store`.\n\nPath Parameter\n--------------\n\n`{in_app_subscription_app_id}`:\
        \ The handle created by Chargebee for your Apple App Store or Google Play\
        \ Store app. It can be obtained from the Chargebee web app.\n\nThe following\
        \ are instructions to obtain the value of the path parameter for the Apple\
        \ App Store and Google Play Store.\n\n* **Apple App Store** : To obtain the\
        \ value for `{in_app_subscription_app_id}`, click **View Keys** within the\
        \ **Sync Overview** page of the web app and use the value of generated **App\
        \ ID** for this parameter. See detailed steps [here](https://www.chargebee.com/docs/1.0/mobile-app-store-product-iap.html#resource-id).\n\
        * **Google Play Store** : To obtain the value for `{in_app_subscription_app_id}`,\
        \ click **Set up notifications** within the **Sync Overview** page of the\
        \ web app and use the value of generated **App ID** for this parameter. See\
        \ detailed steps [here](https://www.chargebee.com/docs/1.0/mobile-playstore-notifications.html#app-id).\n"
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    **Apple App Store** : The Base64 encoded [App Store in-app purchase receipt](https://developer.apple.com/documentation/storekit/original_api_for_in-app_purchase/validating_receipts_with_the_app_store?language=objc#overview) taken from the Apple device after successful creation of the in-app purchase subscription.
                    **Google Play Store** : The purchase `token` taken from the Android device after the successful creation of an in-app purchase subscription.
                  maxLength: 65000
                  example: null
                product:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for product
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: "**Google Play Store** :\nThe unique identifier\
                        \ of the product purchased. The value of this parameter is\
                        \ the `productId`\n/`subscriptionId`\nor `sku`\nreceived from\
                        \ the [Google Play Store](https://developers.google.com/android-publisher/api-ref/rest/v3/inappproducts/get).\
                        \  \n**Note:**\nThe `max chars`\nlimit is `95`\nfor Google\
                        \ Play Store.\n\n**Apple App Store** :\nThe [unique identifier](https://developer.apple.com/documentation/storekit/product/id/)\n\
                        (created in [App Store Connect](https://appstoreconnect.apple.com/login)\n\
                        ) of the product purchased.\n"
                      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: "**Google Play Store** :\nThis parameter is **not\
                        \ applicable**\nto the Google Play Store. If the value is\
                        \ passed, it will return a validation error.\n\n**Apple App\
                        \ Store** :\nThe price paid by the customer for this product.\
                        \ The unit [depends on the type of currency](/docs/api/getting-started).\n\
                        Provide either this or `product[price_in_decimal]`\n.  \n\
                        **Note**:\n\n* When the value of `product[price]` is passed\
                        \ through this API then it will override the product price\
                        \ configured in Chargebee while creating a subscription.\n\
                        * When no `product[price]` is passed and the `product[id]`\
                        \ does not exist in Chargebee then this API will return an\
                        \ error.\n* During the reactivation of a subscription, the\
                        \ old price of the subscription will be considered irrespective\
                        \ of the value of the `product[price]` passed through this\
                        \ API.\n"
                      minimum: 0
                      example: null
                    name:
                      type: string
                      deprecated: false
                      description: |
                        **Google Play Store** :
                        The name (created in [Play Store Console](https://play.google.com/console/about/)
                        ) of the product purchased. If not passed then the `product[id]`
                        will be considered as the value of `product[name]`
                        .
                        optional, string, max chars=46

                        **Apple App Store** :
                        The name (created in [App Store Connect](https://appstoreconnect.apple.com/login)
                        ) of the product purchased.
                      maxLength: 46
                      example: null
                    price_in_decimal:
                      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 price paid by the customer for the product. The value is in decimal and in major units of the currency. Provide either this or `product[price]`
                        .
                      maxLength: 39
                      example: null
                    period:
                      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** :
                        This is the renewal period of the subscription. For example, 1, 2, 3, and so on. This is an `optional`
                        parameter. The parameter value is `required`
                        if the product(s) are not imported to Chargebee from Apple App Store.
                      maxLength: 3
                      example: null
                    period_unit:
                      type: string
                      deprecated: false
                      description: "**Google Play Store** :\nThis parameter is **not\
                        \ applicable**\nto the Google Play Store. If the value is\
                        \ passed, it will return a validation error.\n\n**Apple App\
                        \ Store** :\nThis is the unit of the renewal period. For example,\
                        \ `0`\nrepresents the `day`\n,`1`\nrepresents the `week`\n\
                        , `2`\nrepresents the `month`\n, and `3`\nrepresents the `year`.\n\
                        This is an `optional`\nparameter. The parameter value is `required`\n\
                        if the product(s) are not imported to Chargebee from Apple\
                        \ App Store.  \n**Note**\nSince the Apple App Store receipt\
                        \ does not have the subscription renewal period information\
                        \ for trial subscriptions, `product[period]` and `product[period_unit]`\
                        \ 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.\n"
                      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: |
                        **Google Play Store** :
                        The unique [id](/docs/api/customers/create-a-customer#id)
                        in Chargebee for the customer who made this purchase via Google Play Store. If not provided, `subscription_id`
                        (random unique id) will be the `customer[id]`.
                        If the customer record is not found in Chargebee, it is created.
                        optional, string, max chars=50

                        **Apple App Store** :
                        The unique [id](/docs/api/customers/create-a-customer#id)
                        in Chargebee for the customer who made this purchase. If not provided, the value is considered to be [original_transaction_id](https://developer.apple.com/documentation/appstorereceipts/original_transaction_id?language=objc)
                        (the transaction identifier at Apple, of the original purchase). If the customer record is not found in Chargebee, it is created.
                      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: |
                      Resource object representing in_app_subscription
                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:
      tags:
      - non_subscriptions
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    **Google Play Store** :
                    The purchase `token`
                    taken from the Android device after successful creation of the in-app purchase.

                    **Apple App Store** :
                    The Base64 encoded [App Store in-app purchase receipt](https://developer.apple.com/documentation/storekit/original_api_for_in-app_purchase/validating_receipts_with_the_app_store?language=objc#overview)
                    taken from the Apple device after successful creation of the in-app purchase.
                  maxLength: 65000
                  example: null
                product:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for product
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: "**Google Play Store** : The unique identifier\
                        \ of the product purchased. The value of this parameter is\
                        \ the `productId` or `sku` received from the [Google Play\
                        \ Store](https://developers.google.com/android-publisher/api-ref/rest/v3/inappproducts/get).\
                        \  \n**Note:**\nThe `max chars`\nlimit is `95`\nfor the Google\
                        \ Play Store.\n\n**Apple App Store** : The [unique identifier](https://developer.apple.com/documentation/storekit/product/id/)\
                        \ (created in [App Store Connect](https://appstoreconnect.apple.com/login))\
                        \ of the product purchased.\n"
                      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: |
                        **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 price paid by the customer for this product. The unit [depends on the type of currency](/docs/api/getting-started).
                        Provide either this or `product[price_in_decimal]`
                        .
                      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: |
                        **Google Play Store** :
                        The name (created in [Play Store Console](https://play.google.com/console/about/)
                        ) of the product purchased. If not passed then the `product[id]`
                        will be considered as the value of `product[name]`.

                        **Apple App Store** :
                        The name (created in [App Store Connect](https://appstoreconnect.apple.com/login)
                        ) of the product purchased.
                      maxLength: 96
                      example: null
                    price_in_decimal:
                      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 price paid by the customer for the product. The value is in decimal and in major units of the currency. Provide either this or `product[price]`.
                      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: |
                        **Google Play Store** :
                        The unique [id](/docs/api/customers/create-a-customer#id)
                        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 `customer[id]`.
                        If the customer record is not found in Chargebee, it is created.

                        **Apple App Store** :
                        The unique [id](/docs/api/customers/create-a-customer#id)
                        in Chargebee for the customer who made this purchase. If not provided, the value is considered to be [original_transaction_id](https://developer.apple.com/documentation/appstorereceipts/original_transaction_id?language=objc)
                        (the transaction identifier at Apple, of the original purchase). If the customer record is not found in Chargebee, it is created.
                      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: |
                      Resource object representing non_subscription
                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: []
  /subscriptions/{subscription-id}/entitlement_overrides:
    get:
      tags:
      - subscriptions
      summary: List entitlement overrides for a subscription
      description: |
        Retrieve the list of entitlement overrides for a subscription.
      operationId: list_entitlement_overrides_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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        entitlement_override:
                          $ref: "#/components/schemas/EntitlementOverride"
                          description: Resource object representing entitlement_override
                      required:
                      - entitlement_override
                      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:
      tags:
      - subscriptions
      summary: Upsert or remove entitlement overrides for a subscription
      description: |
        Upserts or removes a set of `entitlement_overrides`
        for a `subscription`
        depending on the `action`
        specified. The API returns the upserted or deleted `entitlement_overrides`
        after successfully completing the operation. The operation returns an error when the first `entitlement_override`
        fails to be processed. Either all the `entitlement_overrides`
        provided in the request are processed or none.
      operationId: upsert_or_remove_entitlement_overrides_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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
                action:
                  type: string
                  deprecated: false
                  description: |
                    The action to perform for each `entitlement_override` specified in the `entitlement_overrides` array.

                    * upsert - If the `entitlement_override` for the `subscription_id`, `feature_id`, and `entity_id` combination already exists, the `value` of the `entitlement_override` is updated. If it doesn't exist, a new `entitlement_override` is created.
                    * remove - Deletes the `entitlement_override` for the `subscription_id`, `feature_id`, and `entity_id` combination, if it exists.
                  enum:
                  - upsert
                  - remove
                  example: null
                entitlement_overrides:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for entitlement_overrides.
                  properties:
                    feature_id:
                      type: array
                      description: |
                        The `id` of the `feature` for which the entitlement override is being set.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    entity_id:
                      type: array
                      description: |
                        The `id` of the entity at whose level the entitlement override is being set for the subscription. If the `entity_id` is not currently a part of the subscription, the `entitlement_override` takes effect as soon as the entity is added to the subscription.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    entity_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The type of the entity at whose level the entitlement override is being set for the subscription.

                          * plan_price - Indicates that the entity is an `item_price` with [`item_type`](/docs/api/item_prices/item-price-object#item_type) set to `plan`.
                          * charge - Indicates that the entity is an `item` with [`type`](/docs/api/items/item-object#type) set to `charge`.
                          * addon_price - Indicates that the entity is an `item_price` with [`item_type`](/docs/api/item_prices/item-price-object#item_type) set to `addon`.
                        enum:
                        - plan_price
                        - addon_price
                        - charge
                        example: null
                      example: null
                    value:
                      type: array
                      description: |+
                        The level of entitlement that the item has towards the feature. The possible values depend on the value of `feature.type`
                        :

                        * When `feature.type` is `quantity` and:

                        * If `feature.levels[is_unlimited]` is not `true` for any one of `feature.levels[]`, then the value can be any one of `feature.levels[value][]`.

                        * If `feature.levels[is_unlimited]` is `true` for one of the `feature.levels[]`, then the value can also be:

                          * any one of `feature.levels[value][]`
                          * or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.
                        * When `type` is `range` and:

                        * If `feature.levels[is_unlimited]` is not `true` for any one of `feature.levels[]`, then the value can be any whole number between `levels[value][0]` and `levels[value][1]` (inclusive).

                        * If `feature.levels[is_unlimited]` is `true` for one of the `feature.levels[]`, then the value can be:

                          * any whole number equal to or greater than `levels[value][0]`
                          * or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.
                        * When `type` is `custom`, then the value can be any one of `feature.levels[value][]`.

                        * When `type` is `switch`, then the value is set as `true` if the feature is available; it is set as `false` when the feature is unavailable.

                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    expires_at:
                      type: array
                      description: "The expiry date for the `entitlement_override`.\
                        \ The `entitlement_override` object is no longer returned\
                        \ after this date has passed.  \n**Constraints**\n\n* Applicable\
                        \ only for subscription-level entitlement overrides. i.e.\
                        \ Not applicable when `entity_id` and `entity_type` are set.\n\
                        * The `action` must be `upsert`.\n* Must be a value in the\
                        \ future.\n"
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    effective_from:
                      type: array
                      description: "The starting date and time for the entitlement\
                        \ override. It indicates when the override becomes effective.\
                        \  \n**Constraints**\n\n* Applicable only for subscription-level\
                        \ entitlement overrides. i.e. Not applicable when `entity_id`\
                        \ and `entity_type` are set.\n* The `action` must be `upsert`.\n\
                        * Must be a value in the future.\n"
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                    is_enabled:
                      type: array
                      description: ""
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                  required:
                  - feature_id
                  example: null
              example: null
            encoding:
              entitlement_overrides:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        entitlement_override:
                          $ref: "#/components/schemas/EntitlementOverride"
                          description: Resource object representing entitlement_override
                      required:
                      - entitlement_override
                      example: null
                    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: []
  /business_entities/transfers:
    get:
      tags:
      - business_entities
      summary: List business entity transfers
      description: "Returns a list of [business_entity_transfer](/docs/api/business_entity_transfers)\
        \ resources meeting all the conditions specified in the filter parameters\
        \ below. By default, this list is sorted by `created_at` in descending order\
        \ (latest first).  \n**Tip**\n\nTo retrieve a history of all the business\
        \ entity transfers for a resource, pass the filter parameters [active_resource_id[is]](/docs/api/business_entities/list-the-business-entity-transfers)\
        \ and [resource_type[]](/docs/api/business_entities/list-the-business-entity-transfers).\n"
      operationId: list_the_business_entity_transfers
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: resource_type
        in: query
        description: "Filter [business_entity_transfer](/docs/api/business_entity_transfers)\
          \ resources based on [resource_type](/docs/api/business_entity_transfers/business_entity_transfer-object#resource_type).\
          \  \n**Tip**\nUse this filter along with [active_resource_id[is]](/docs/api/business_entities/list-the-business-entity-transfers)\
          \ to retrieve the history of all the business entity transfers for a resource.\n"
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: customer
          properties:
            is:
              type: string
              minLength: 1
              example: null
      - name: resource_id
        in: query
        description: |
          Filter [business_entity_transfer](/docs/api/business_entity_transfers)
          resources based on [resource_id](/docs/api/business_entity_transfers/business_entity_transfer-object#resource_id)
          .
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: 9bsvnHgsvmsI
          properties:
            is:
              type: string
              minLength: 1
              example: null
      - name: active_resource_id
        in: query
        description: "Filter [business_entity_transfer](/docs/api/business_entity_transfers)\
          \ resources based on [active_resource_id](/docs/api/business_entity_transfers/business_entity_transfer-object#active_resource_id).\
          \  \n**Tip**\nUse this filter along with [resource_type[]](/docs/api/business_entities/list-the-business-entity-transfers)\
          \ to retrieve the history of all the business entity transfers for a resource.\n"
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: 8gsnbYfsMLds
          properties:
            is:
              type: string
              minLength: 1
              example: null
      - name: created_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          To filter based on Created At.
          **Supported operators :**
          after, before, on, between

          **Example →**
          *created_at\[on\] = "1702022464"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1702022464"
          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:
                        business_entity_transfer:
                          $ref: "#/components/schemas/BusinessEntityTransfer"
                          description: Resource object representing business_entity_transfer
                      required:
                      - business_entity_transfer
                      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:
      tags:
      - business_entities
      summary: Transfer a customer to another business entity
      description: "**Important**\nThis API will not work if you have [specified a\
        \ business entity](/docs/api/advanced-features#mbe-header-main) in the custom\
        \ HTTP header.\n\nTransfers one or more [customer](/docs/api/customers) resources\
        \ from one business entity to another.\n\nThe transfer is executed by creating\
        \ a copy of the `customer` resource. The original resource is deprecated,\
        \ while the new copy becomes the active resource.  \nMore details  \n\n####\
        \ Prerequisites {#transfer-more-content}\n\n* Transfers must always be initiated\
        \ for an active `customer` resources and never for a deprecated resources.\n\
        \n* A `customer` resource cannot be transferred more than three times in a\
        \ single calendar year. For example, if already moved thrice in the year 2023,\
        \ a `customer` resource can only be moved again in 2024.\n\n* The `customer`\
        \ resource must not have any of the following:\n\n  * An account hierarchy\
        \ [relationship](/docs/api/customers/customer-object#relationship).\n\n  *\
        \ `subscription` resource with\n\n    * `status` `in_trial` or\n    * advance\
        \ invoice schedules. ([subscription.has_scheduled_advance_invoices](/docs/api/subscriptions/subscription-object#has_scheduled_advance_invoices)\
        \ as `true`.)\n  * [invoice](/docs/api/invoices) resource with `status` as\
        \ `pending`. ([Close pending invoices](/docs/api/invoices/close-a-pending-invoice)\
        \ before invoking this API.)\n\n  * `invoice` resources that are advance invoices.\
        \ ([invoice.has_advance_charges](/docs/api/invoices/invoice-object#has_advance_charges)\
        \ as `true`.)\n\n  * [quote](/docs/api/quotes) resources with `status` as\
        \ `open` or `accepted`.\n\n  * [transaction](/docs/api/transactions) resource\
        \ with:\n\n    * `status` as `in_progress` or\n    * `status` as `success`,\
        \ `type` as `authorization`, and a non-zero `amount_capturable`.\n  * Non-zero\
        \ [unbilled_charges](/docs/api/customers/customer-object#unbilled_charges).\
        \ ([Invoice unbilled charges](/docs/api/unbilled_charges/create-an-invoice-for-unbilled-charges)\
        \ before invoking this API.)\n\n  * Non-zero [refundable_credits](/docs/api/customers/customer-object#refundable_credits).\
        \ ([Apply credits](/docs/api/invoices/apply-credits-for-an-invoice) to unpaid\
        \ invoices before invoking this API.)\n\n* The `customer` resource must not\
        \ be a [gifter](/docs/api/gifts/gift-object#gifter) of a gift subscription\
        \ with [status](/docs/api/gifts/gift-object#status) `scheduled` or `unclaimed`.\n\
        \n#### Mechanics of business entity transfer\n\nWhen calling this endpoint,\
        \ the active and deprecated resources are processed as follows:\n\n1. For\
        \ the active resource:\n\n   1. `id` and `active_id` are set to match the\
        \ deprecated resource's `id`.\n   2. `business_entity_id` is set to `destination_business_entity_id`\
        \ parameter.\n2. For the deprecated resource:\n\n   1. For `customer` and\
        \ `subscription` resources, the value of `active_id` is set to match the resource\
        \ `id`.\n   2. The value of `id` is changed to a new random value.\n\n####\
        \ Considerations for business entity transfer\n\n* When this API is endpoint\
        \ is called, Chargebee blocks concurrent calls to incompatible `POST` operations.\n\
        \n* When a resource is transferred more than once, each transfer deprecates\
        \ the previous active resource and creates a new active resource.\n\n* `payment_source`\
        \ resources linked to the `customer` are immediately transferred to the destination\
        \ business entity.\n\n* `subscription` resources linked to the `customer`\
        \ are transferred automatically to the destination business entity as follows:\n\
        \n  * `active` subscription resources are transferred on their next renewal.\n\
        \  * `paused` subscription resources are transferred when resumed.\n  * `future`\
        \ subscription resources are transferred on their [start_date](/docs/api/subscriptions/subscription-object#start_date).\n\
        \  * `non_renewing` and `cancelled` subscription resources are not transferred\
        \ and remain linked to the deprecated customer resource.\n* Other resources\
        \ linked to the customer, such as `invoice`, `quote`, `credit_note`, and `transaction`,\
        \ remain linked to the deprecated customer resource.\n\n* Deprecated `customer`\
        \ and `subscription` resources are not returned in list APIs such as [List\
        \ customers](/docs/api/customers/list-customers) or [List subscriptions](/docs/api/subscriptions/list-subscriptions).\n\
        \n**See also**\n\n* [Permitted operations](https://www.chargebee.com/docs/2.0/mbe-data-management-actions.html)\
        \ on deprecated and active resources.\n* [Additional considerations for business\
        \ entity transfer.](https://www.chargebee.com/docs/2.0/mbe-about-resources-and-managing-associated-workflow-processes.html)\n\
        \n#### Example\n\nThe following example illustrates the transfer of a `customer`\
        \ resource from a business entity (source) to another (destination). The example\
        \ also shows how [payment_source](/docs/api/payment_sources), `subscription`,\
        \ and `invoice` resources attached to the `customer` resource are affected.\n\
        \n##### 1. Initial state before the transfer\n\nImagine a `customer`\nresource\
        \ with the `id`\n`Ab6dRFt`\nbelonging to the business entity `acme-us`\n.\
        \ This customer has a linked `payment_source`\n, `subscription`\n, and an\
        \ `invoice`\n.\nscreenshot\\|/images/transfer_resource_1.jpg\n\n##### 2. Invoking\
        \ the API endpoint\n\nTo transfer the `customer` resource to a new business\
        \ entity `acme-eu`, you would call the endpoint as follows:\n\n```shell\n\n\
        curl  https://{site}.chargebee.com/api/v2/business_entities/transfers \\\n\
        -u {api_key}:\\\n-d active_resource_ids[0]=\"Ab6dRFt\" \\\n-d destination_business_entity_ids[0]=\"\
        acme-us\" \\\n-d reason_code[0]=\"correction\"\n    \n```\n\nThe `customer`\
        \ resource is deprecated in favor of a new active `customer` resource. Notice\
        \ that the `id` of the deprecated `customer` resource is transferred to the\
        \ new, active `customer` resource. Meanwhile, the deprecated resource is assigned\
        \ a new random `id`.\n\nThe `payment_source` resource is also deprecated and\
        \ a new active `payment_source` resource is created and linked to the new\
        \ `customer` resource. Here too, the active resource adopts the `id` of the\
        \ deprecated `payment_source`, which in turn is assigned a new random `id`.\n\
        \nThe `subscription` and `invoice` resources remain linked to the deprecated\
        \ `customer` resource.\nscreenshot\\|/images/transfer_resource_2.jpg\n\n#####\
        \ 3. Transfer of linked `subscription` resources\n\nWhen the `subscription`\
        \ renews, it automatically transfers to the business entity of the active\
        \ `customer` resource. This process mirrors the transfer of the `customer`\
        \ resource, resulting in a new active `subscription` resource linked to the\
        \ active `customer` resource and the business entity `acme-eu`.\nscreenshot\\\
        |/images/transfer_resource_3.jpg\n"
      operationId: transfer_resources_to_another_business_entity
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                active_resource_ids:
                  type: array
                  deprecated: false
                  description: "The list of unique identifiers of the `customer` resources\
                    \ to be transferred. Each `id` must belong to an active `customer`\
                    \ resource.  \n**Note**\nIf a `customer` resource was deprecated\
                    \ because it was moved previously, you cannot move it again. Instead,\
                    \ move the active version of the resource. Do this by passing\
                    \ the `active_id` of the deprecated resource.\n"
                  items:
                    type: string
                    deprecated: false
                    maxLength: 50
                    example: null
                  example: null
                destination_business_entity_ids:
                  type: array
                  deprecated: false
                  description: |
                    The list of unique identifiers of the `business_entity` resources to which the corresponding `customer` resource must be transferred.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 50
                    example: null
                  example: null
                reason_codes:
                  type: array
                  deprecated: false
                  description: |
                    The list of [reasons](/docs/api/business_entity_transfers/business_entity_transfer-object#reason_code)
                    for changing the business entity of the corresponding `customer`
                    resources.
                  items:
                    type: string
                    deprecated: false
                    maxLength: 50
                    example: null
                  example: null
              required:
              - active_resource_ids
              - destination_business_entity_ids
              - reason_codes
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  business_entity_transfer:
                    $ref: "#/components/schemas/BusinessEntityTransfer"
                    description: |
                      Resource object representing `business_entity_transfer`
                      .
                required:
                - business_entity_transfer
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /purchases:
    post:
      tags:
      - purchases
      summary: Create a purchase
      description: "**Deprecated.** The Purchase API is deprecated. It still works\
        \ and existing integrations are unaffected, but it's no longer recommended\
        \ for new integrations. Support for purchasing multiple plans in a single\
        \ subscription is planned for the [Subscriptions API](/docs/api/subscriptions).\n\
        \nCreates a `purchase` resource. A purchase can contain one or more of the\
        \ following:\n\n* subscriptions (a [subscription](/docs/api/subscriptions)\
        \ resource consists of item prices such that at least one of the item prices\
        \ belongs to an [item](/docs/api/items) of `type` `plan`.)\n* group of one-time\
        \ charges (aka [charge item prices](/docs/api/item_prices))\n\nWhen you call\
        \ this API, the invoices for the subscription(s) and one-time charge(s) are\
        \ created immediately and not left [unbilled](/docs/api/subscriptions/create-subscription-for-items#invoice_immediately)\n\
        .  \n**Note**\n\nProviding `shipping_addresses[]` is required when the [Orders\
        \ feature](https://www.chargebee.com/docs/2.0/orders.html#configuration_step-1-configure-site-wide-settings)\
        \ has been enabled.\n\n### Specifying `purchase_item` groups\n\nWhen creating\
        \ a purchase, you must specify the *group* or `index` to which each item price\
        \ belongs. You can do this by setting the `purchase_items[index]` for each\
        \ item price. Item prices with the same `purchase_items[index]` belong to\
        \ the same group.\nThe grouping of item prices allows you to specify the `discounts[]`\
        \ applicable for each group and indicate which item prices should be added\
        \ to any subscriptions you want to create. Groups can be one of two types:\n\
        \n* Subscription groups\n* One-time charge groups\n\nThe following subsections\
        \ describe the types of groups in detail.  \n**Note**\n\nYou can specify up\
        \ to 10 groups,\n\n* with a recommended subscription group of 5. To increase\
        \ this limit to a maximum of 8, contact eap@chargebee.com.\n* with a maximum\
        \ of 10 one-time charge groups by default.\n\nThe total limit for group items\
        \ for a single purchase is 60.\n\n#### Subscription groups\n\nTo create a\
        \ subscription, specify a *subscription group* . A subscription [group](/docs/api/purchases)\
        \ is a group of item prices that contains exactly one item price of `type`\
        \ `plan`. To create multiple subscriptions, provide multiple subscription\
        \ groups.  \n**Note**\n\nA subscription group can have up to 20 non-plan item\
        \ prices. To increase this limit to a maximum of 60, contact eap@chargebee.com.\n\
        \n#### Custom Fields\n\nPurchase API supports custom fields of Subscriptions,\
        \ use the following format to specify custom fields in Purchase API: **`subscription_info[custom_field]`**.\n\
        \n#### One-time charge groups\n\nA one-time charge [group](/docs/api/purchases)\
        \ is a group of charge item prices (i.e. item prices belonging to items of\
        \ `type` `charge`). Charge item prices can be added to subscription groups\
        \ as well. The charges within and across each one-time group must be unique.\
        \  \n**Note**\n\n* A one-time charge group can have up to 20 item prices.\
        \ To increase this limit to a maximum of 60, contact eap@chargebee.com.\n\
        * A charge item price can only be added to a single one-time charge group.\
        \ However, it can be part of multiple [subscription groups](/docs/api/purchases).\n\
        \n### Applying discounts\n\nDiscounts, both [manual discounts](/docs/api/discounts)\
        \ and [coupons](/docs/api/coupons), can be applied to groups by specifying\
        \ the `discounts[]` array. The following table describes the method of application\
        \ based on whether `discounts[index][i]` is provided:  \n\n|             \
        \         |                                                              \
        \                                                                        \
        \                             **`discounts[index][i]` is provided**      \
        \                                                                        \
        \                                                                        \
        \              |                                                         \
        \                            **`discounts[index][i]` is not provided**   \
        \                                                                        \
        \           |\n|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n\
        | **Coupons**          | * The coupon is applied exclusively to the invoice\
        \ for group `i`. * The coupon is applied exclusively to the invoice created\
        \ immediately upon invoking this API. * If group `i` is a [subscription group](/docs/api/purchases),\
        \ then the coupon is applied to invoices for subscription renewals based on\
        \ coupon attributes such as `duration_type` and `max_redemptions`. | * The\
        \ coupon is applied to all the invoices immediately generated upon invoking\
        \ this API. * The coupon is not applied to subsequent invoices, such as those\
        \ generated upon subscription renewal.                   |\n| **Manual discounts**\
        \ | * The manual discount is applied exclusively to the invoice for group\
        \ `i`. * The manual discount is applied exclusively to the invoice created\
        \ immediately upon invoking this API. * The manual discount is not applied\
        \ to subsequent invoices, such as those generated upon subscription renewal.\
        \                                                                        \
        \ | * The manual discount is applied to all the invoices immediately generated\
        \ upon invoking this API. * The manual discount is not applied to subsequent\
        \ invoices, such as those generated upon subscription renewal. |\n\n"
      operationId: create_a_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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](/docs/api/customers)
                    that made this purchase.
                  maxLength: 50
                  example: null
                payment_source_id:
                  type: string
                  deprecated: false
                  description: |
                    Payment source attached to this purchase. If present, the customer's payment sources won't be used to collect any payment for this purchase.
                  maxLength: 40
                  example: null
                replace_primary_payment_source:
                  type: boolean
                  default: true
                  deprecated: false
                  description: |
                    Indicates whether the primary payment source is replaced with this payment source. If a `payment_intent`
                    object is included in the request, `replace_primary`
                    defaults to `true`.
                    For all other cases, the default is `false`
                    .
                  example: null
                invoice_info:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for invoice_info
                  properties:
                    po_number:
                      type: string
                      deprecated: false
                      description: |
                        The [purchase order number](https://www.chargebee.com/docs/2.0/po-number.html)
                        for this purchase. This is reflected in all the subscriptions and invoices under this purchase.
                      maxLength: 100
                      example: null
                    notes:
                      type: string
                      deprecated: false
                      description: |
                        A customer-facing note added to the PDF of the first invoice associated with this purchase. This is added to [invoice.notes](/docs/api/invoices/invoice-object#notes).
                        Subsequent invoices do not have this note.
                      maxLength: 2000
                      example: null
                  example: null
                payment_schedule:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for `payment_schedule`
                  properties:
                    scheme_id:
                      type: string
                      deprecated: false
                      description: |
                        The identifier of the `payment_schedule_scheme`
                        , used to create the payment schedules.
                      maxLength: 40
                      example: null
                    amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        The part of the `invoice.amount_due`
                        to be distributed across the payment schedules. If not specified, the entire `invoice.amount_due`
                        is considered by default.
                      minimum: 0
                      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 you pass this value it will override the [transaction descriptor](https://www.chargebee.com/docs/2.0/transaction_descriptors.html)
                        text configured on your Chargebee site for the first [consolidated invoice](https://www.chargebee.com/docs/2.0/consolidated-invoicing.html)
                        .
                      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#3ds-gateway-side-implementation) 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 based payment including credit cards and debit cards.
                        * swish - Swish
                        * twint - Twint
                        * dotpay - Payments made via Dotpay.
                        * faster_payments - Faster Payments
                        * upi - UPI Payments.
                        * kbc_payment_button - KBC Payment Button
                        * klarna - Klarna
                        * payme - PayMe
                        * thai_qr - Payments made via Thai QR.
                        * go_pay - Go Pay
                        * google_pay - Payments made via Google Pay.
                        * trustly - Trustly
                        * naver_pay - Naver Pay
                        * stablecoin - Stablecoin
                        * paypal_express_checkout - Payments made via PayPal Express Checkout.
                        * pix - Payments made via Pix
                        * venmo - Venmo
                        * klarna_pay_now - Klarna Pay Now
                        * alipay - Alipay
                        * tamara - Payments made via Tamara.
                        * ideal - Payments made via iDEAL.
                        * picpay - Payments made via PicPay.
                        * pay_to - PayTo
                        * ovo - Payments made via OVO.
                        * boleto - Payments made via Boleto.
                        * pay_co - Pay Co
                        * wechat_pay - WeChat Pay
                        * cash_app_pay - Cash App Pay
                        * rakuten_pay - Payments made via Rakuten Pay.
                        * alipay_hk - Payments made via Alipay HK.
                        * after_pay - After Pay
                        * netbanking_emandates - Netbanking (eMandates) Payments.
                        * nequi - Payments made via Nequi.
                        * grab_pay - Grab Pay
                        * paypay - PayPay
                        * payconiq_by_bancontact - Payconiq by Bancontact
                        * mercado_pago - Payments made via Mercado Pago.
                        * p24 - Payments made via Przelewy24 (P24).
                        * electronic_payment_standard - Electronic Payment Standard
                        * direct_debit - Payments made via Direct Debit.
                        * sepa_instant_transfer - Sepa Instant Transfer
                        * bancontact - Payments made via Bancontact Card.
                        * wero - Payments made via Wero.
                        * pay_by_bank - Pay By Bank
                        * touch_n_go - Payments made via Touch 'n Go.
                        * apple_pay - Payments made via Apple Pay.
                        * qpay - Payments made via Qpay.
                        * online_banking_poland - Online Banking Poland
                        * gcash - Payments made via GCash.
                        * nupay - Payments made via NuPay.
                        * giropay - Payments made via giropay.
                        * momo - Payments made via MoMo.
                        * sofort - Payments made via Sofort.
                        * amazon_payments - Amazon Payments
                        * affirm_pay - Payments made via Affirm Pay.
                        * kakao_pay - Kakao Pay
                        * fpx - Payments made via FPX.
                        * blik - Payments made via BLIK.
                        * dana - Payments made via Dana.
                        * south_korean_cards - Payments made via South Korean Cards
                        * revolut_pay - 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
                      - alipay_hk
                      - paypay
                      - gcash
                      - south_korean_cards
                      - paynow
                      - bizum
                      - promptpay
                      - dana
                      - touch_n_go
                      - tamara
                      - qpay
                      - ovo
                      - momo
                      - mercado_pago
                      - nequi
                      - nupay
                      - picpay
                      - thai_qr
                      - blik
                      - fpx
                      - wero
                      - p24
                      - affirm_pay
                      - rakuten_pay
                      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: |
                        * `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal).

                          * `payer`: User related information.
                            * `country_of_residence`: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a [two-character ISO code](https://docs.checkout.com/resources/codes/country-codes).
                            * `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
                        * `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
                        * `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user's `device_session_id` can be added to perform [additional validation](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                            * `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
                        * `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
                        * `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.

                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device.
                        * `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.

                          * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
                        * `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.

                          * `payer`: User related information.
                            * `document`: Document is the user's identification number based on their country.
                          * `fraud`: Fraud identification related information.
                            * `device_session_id`: Session ID associated with the user's device
                      example: null
                  example: null
                purchase_items:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for purchase_items
                  properties:
                    index:
                      type: array
                      description: |
                        The index or identifier of the [group](/docs/api/purchases)
                        to which the item price belongs. The item prices assigned the same index belong to the same group.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    item_price_id:
                      type: array
                      description: |
                        The unique identifier of the [item price](/docs/api/item_prices)
                        to be added to the [group](/docs/api/purchases)
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        The quantity of the item price. Applicable only when the [pricing model](/docs/api/item_prices/item_price-object#pricing_model)
                        of the item price is anything other than `flat_fee`.
                        You can provide this value whether [multi-decimal pricing](/docs/api/currencies)
                        is enabled or disabled.
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    unit_amount:
                      type: array
                      description: |
                        The price or per unit price of the item. You may provide this only when [price overriding](https://www.chargebee.com/docs/2.0/price-override.html)
                        is enabled for the site.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_amount_in_decimal:
                      type: array
                      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/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the item purchased. By default [multi-decimal pricing](/docs/api/currencies)
                        is enabled for purchase API, it is recommended to use the `purchase_items[quantity_in_decimal][0..n]`
                        for providing quantity-based item prices when multi-decimal pricing is enabled. When multi-decimal pricing is disabled provide the value in `purchase_items[quantity][0..n]`
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                  required:
                  - index
                  - item_price_id
                  example: null
                item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_tiers
                  properties:
                    index:
                      type: array
                      description: |
                        The index or identifier of the [group](/docs/api/purchases)
                        to which this tier information belongs. This must be a value from the `purchase_items[index]`
                        array.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    item_price_id:
                      type: array
                      description: |
                        The unique ID of the item price to which this tier information belongs. This must be a value from the `purchase_items[item_price_id]`
                        array.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: |
                        The lowest value of quantity in this tier; this is zero for the lowest tier. For all other tiers, it is the same as `ending_unit_in_decimal`
                        of the very next lower tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The highest value of quantity in this tier. For all other tiers,it must be equal to the `starting_unit_in_decimal`
                        of the very next higher tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |
                        The per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the total price of the item. The currency units in which this value is expressed [depends](/docs/api/currencies)
                        on the type of currency.
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                  required:
                  - index
                  example: null
                shipping_addresses:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for shipping_addresses
                  properties:
                    first_name:
                      type: array
                      description: |
                        The first name of the contact. This parameter is `mandatory`
                        when providing shipping information.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 150
                        example: null
                      example: null
                    last_name:
                      type: array
                      description: |
                        The last name of the contact. This parameter is `mandatory`
                        when providing shipping information.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 150
                        example: null
                      example: null
                    email:
                      type: array
                      description: |
                        The email address.
                      items:
                        type: string
                        format: email
                        deprecated: false
                        maxLength: 70
                        example: null
                      example: null
                    company:
                      type: array
                      description: |
                        The company name.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 250
                        example: null
                      example: null
                    phone:
                      type: array
                      description: |
                        The phone number.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    line1:
                      type: array
                      description: |
                        Address line 1. This parameter is `mandatory`
                        when providing shipping information.
                      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: |
                        The name of the city. This parameter is `mandatory`
                        when providing shipping information.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    state:
                      type: array
                      description: |
                        The state/province name.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    state_code:
                      type: array
                      description: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ).
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    country:
                      type: array
                      description: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html).\n\
                        This parameter is `mandatory`\nwhen providing shipping information.\n\
                        \n**Note**:\nIf you enter an invalid country code, the system\
                        \ will return an error.  \n**Brexit**\n\nIf you have enabled\
                        \ [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in\
                        \ 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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://chromium-i18n.appspot.com/ssl-address).
                        This parameter is `mandatory`
                        when providing shipping information.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 20
                        example: null
                      example: null
                    validation_status:
                      type: array
                      items:
                        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: object
                  deprecated: false
                  description: |
                    Parameters for discounts
                  properties:
                    index:
                      type: array
                      description: "The index or identifier of the [group](/docs/api/purchases)\n\
                        to which this discount or coupon information belongs. This\
                        \ must be a value from the `purchase_items[index]` array.\
                        \ When not provided, the coupon is applied to the first invoice\
                        \ only; irrespective of the values set for [coupon.duration_type](/docs/api/coupons/coupon-object#duration_type)or\
                        \ [coupon.max_redemptions](/docs/api/coupons/coupon-object#max_redemptions).\
                        \  \n**See also:**\n[Applying discounts](/docs/api/purchases)\n"
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    coupon_id:
                      type: array
                      description: "The unique ID of a coupon to be applied to the\
                        \ group. Alternatively, you may provide a [coupon code](/docs/api/coupon_codes).\
                        \ Applicable only for [coupons](/docs/api/coupons).  \n**See\
                        \ also:**\n[Applying discounts](/docs/api/purchases)\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    percentage:
                      type: array
                      description: "The percentage of the discount. Applicable only\
                        \ for [manual discounts](/docs/api/discounts). For any given\
                        \ array index `i`, provide `discounts[percentage][i]` or `discounts[quantity][i]`\
                        \ or `discounts[amount][i]`  \n**See also:**\n[Applying discounts](/docs/api/purchases)\n"
                      items:
                        type: number
                        format: double
                        deprecated: false
                        maximum: 100
                        minimum: 0.01
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: "The discount quantity. Applicable only for [manual\
                        \ discounts](/docs/api/discounts). For any given array index\
                        \ `i`, provide `discounts[percentage][i]` or `discounts[quantity][i]`\
                        \ or `discounts[amount][i]`  \n**See also:**\n[Applying discounts](/docs/api/purchases)\n"
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    amount:
                      type: array
                      description: "The absolute value of the discount. The currency\
                        \ units in which this value is expressed [depends](/docs/api/currencies)\
                        \ on the type of currency. Applicable only for [manual discounts](/docs/api/discounts).\n\
                        For any given array index `i`, you can provide `discounts[percentage][i]`\
                        \ or `discounts[quantity][i]` or `discounts[amount][i]`  \n\
                        **See also:**\n[Applying discounts](/docs/api/purchases)\n"
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    included_in_mrr:
                      type: array
                      description: |
                        For [manual discounts](/docs/api/discounts), set this to `false` if this manual discount should be excluded from monthly recurring revenue (MRR) calculations for the site. The following prerequisites must be met to allow this parameter to be passed:

                        * The feature must be [enabled in Chargebee](https://www.chargebee.com/docs/2.0/reporting.html#dashboards_flexible-mrr-calculation).
                        * The [site-level](https://www.chargebee.com/docs/2.0/reporting.html#chart_flexible-mrr-calculation) setting must be to include coupons in MRR calculations.

                        **See also:**
                        [Applying discounts](/docs/api/purchases)
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                  example: null
                subscription_info:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription_info
                  properties:
                    index:
                      type: array
                      description: |
                        The index or identifier of the [group](/docs/api/purchases)
                        to which this subscription information belongs. This must be a value from the `purchase_items[index]`
                        array and the group must be a [subscription group](/docs/api/purchases)
                        .
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    subscription_id:
                      type: array
                      description: |
                        When specifying a [subscription group](/docs/api/purchases)
                        , this is the unique identifier of the [subscription](/docs/api/subscriptions)
                        to be created. This value must be unique for each subscription group.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles [set for the plan-item price](/docs/api/item_prices/item_price-object#billing_cycles)
                        is used.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    contract_term_billing_cycle_on_renewal:
                      type: array
                      description: |
                        Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as `billing_cycles`
                        or a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)
                        .
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 100
                        minimum: 1
                        example: null
                      example: null
                    meta_data:
                      type: array
                      description: "A collection of key-value pairs that provides\
                        \ extra information about the purchase.  \n**Note:**\nThere's\
                        \ a character limit of 65,535.\n\n[Learn more](/docs/api/advanced-features)\n\
                        .\n"
                      items:
                        type: object
                        additionalProperties: true
                        deprecated: false
                        example: null
                      example: null
                  required:
                  - index
                  example: null
                contract_terms:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for contract_terms
                  properties:
                    index:
                      type: array
                      description: |
                        The index number of the subscription/one-time group to which the item price is added. Provide a unique number between `0`
                        and `9`
                        (inclusive) for each group that is to be created. To increase this limit, contact Chargebee Support
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    action_at_term_end:
                      type: array
                      items:
                        type: string
                        default: renew
                        deprecated: false
                        description: |
                          Action to be taken when the contract term completes.

                          * renew -
                            * Contract term completes and a new contract term is started for the number of billing cycles specified in [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).
                            * The `action_at_term_end` for the new contract term is set to `renew`.
                          * renew_once -
                            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 [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).

                            * The `action_at_term_end` for the new contract term is set to `cancel`.
                          * evergreen - Contract term completes and the subscription renews.
                          * cancel - Contract term completes and subscription is canceled.
                        enum:
                        - renew
                        - evergreen
                        - cancel
                        - renew_once
                        example: null
                      example: null
                    cancellation_cutoff_period:
                      type: array
                      description: |
                        The number of days before [`contract_end`](/docs/api/contract_terms/contract_term-object#contract_end)
                        , 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.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                  required:
                  - index
                  example: null
              required:
              - customer_id
              example: null
            encoding:
              contract_terms:
                style: deepObject
                explode: true
              discounts:
                style: deepObject
                explode: true
              invoice_info:
                style: deepObject
                explode: true
              item_tiers:
                style: deepObject
                explode: true
              payment_intent:
                style: deepObject
                explode: true
              payment_schedule:
                style: deepObject
                explode: true
              purchase_items:
                style: deepObject
                explode: true
              shipping_addresses:
                style: deepObject
                explode: true
              statement_descriptor:
                style: deepObject
                explode: true
              subscription_info:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  purchase:
                    $ref: "#/components/schemas/Purchase"
                    description: |
                      Resource object representing purchase
                required:
                - purchase
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /purchases/estimate:
    post:
      tags:
      - purchases
      summary: Estimates for purchase
      description: |
        **Deprecated.** The Purchase API is deprecated. It still works and existing integrations are unaffected, but it's no longer recommended for new integrations. Support for purchasing multiple plans in a single subscription is planned for the [Subscriptions API](/docs/api/subscriptions).

        Returns an estimate for creating a `purchase` resource. The operation works exactly like [Create a purchase](/docs/api/purchases/create-a-purchase), except that only an [estimate](/docs/api/estimates) resource is returned without an actual `purchase` resource being created.
      operationId: estimates_for_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                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
                customer_id:
                  type: string
                  deprecated: false
                  description: |
                    The unique identifier of the [customer](/docs/api/customers)
                    that made this purchase.
                  maxLength: 50
                  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: |
                        An overridden value for the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number).
                        Only applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)

                        `country`
                        as `XI`
                        (which is **United Kingdom - Northern Ireland**
                        ).

                        When you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)
                        in 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)
                        the Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)

                        `country`
                        as `XI`.
                        That's the code for **United Kingdom - Northern Ireland** .
                        The first two characters of the VAT number in such a case is
                        `XI`
                        by default. However, if the VAT number was registered in UK, the value should be `GB`.
                        Set
                        `vat_number_prefix`
                        to `GB`
                        for such cases.
                      maxLength: 10
                      example: null
                    registered_for_gst:
                      type: boolean
                      deprecated: false
                      description: |
                        Confirms that a customer is registered under GST. If set to `true`
                        then the [Reverse Charge Mechanism](https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism)
                        is applicable. This field is applicable only when Australian GST is configured for your site.
                      example: null
                    taxability:
                      type: string
                      default: taxable
                      deprecated: false
                      description: |
                        Specifies if the customer is liable for tax

                        * exempt -
                          * Customer is exempted from tax. When using Chargebee's native [Taxes](https://www.chargebee.com/docs/tax.html) feature or when using the [TaxJar integration](https://www.chargebee.com/docs/taxjar.html), no other action is needed.
                          * However, when using our [Avalara integration](https://www.chargebee.com/docs/avalara.html), optionally, specify `entity_code` or `exempt_number` attributes if you use Chargebee's [AvaTax for Sales](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption) or specify `exemption_details` attribute if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. Tax may still be applied by Avalara for certain values of `entity_code`/`exempt_number`/`exemption_details` based on the state/region/province of the taxable address.
                        * zero_rated - This option is available only when zero-rated customer taxability is enabled for the site and the site uses [Chargebee Taxes](https://www.chargebee.com/docs/tax.html); third-party tax providers and integrations are not supported. Otherwise taxable line items for the customer are taxed at 0%. These line items have `is_taxed` set to `true`, the tax rate and tax amount set to `0`, and `tax_exempt_reason` set to `zero_rated`. Unlike `exempt`, this option follows the taxable tax path at a zero rate.
                        * taxable -
                          Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html).
                          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.
                      enum:
                      - taxable
                      - exempt
                      - zero_rated
                      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
                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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ).
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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
                purchase_items:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for purchase_items
                  properties:
                    index:
                      type: array
                      description: |
                        The index or identifier of the [group](/docs/api/purchases)
                        to which the item price belongs. The item prices assigned the same index belong to the same group.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    item_price_id:
                      type: array
                      description: |
                        The unique identifier of the [item price](/docs/api/item_prices)
                        to be added to the [group](/docs/api/purchases)
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        The quantity of the item price. Applicable only when the [pricing model](/docs/api/item_prices/item_price-object#pricing_model)
                        of the item price is anything other than `flat_fee`.
                        You can provide this value whether [multi-decimal pricing](/docs/api/currencies)
                        is enabled or disabled.
                      items:
                        type: integer
                        format: int32
                        default: 1
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    unit_amount:
                      type: array
                      description: |
                        The price or per unit price of the item. You may provide this only when [price overriding](https://www.chargebee.com/docs/2.0/price-override.html)
                        is enabled for the site.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_amount_in_decimal:
                      type: array
                      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/getting-started)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    quantity_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the quantity of the item purchased. By default [multi-decimal pricing](/docs/api/getting-started)
                        is enabled for purchase API, it is recommended to use the `purchase_items[quantity_in_decimal][0..n]`
                        for providing quantity-based item prices when multi-decimal pricing is enabled. When multi-decimal pricing is disabled provide the value in `purchase_items[quantity][0..n]`
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                  required:
                  - index
                  - item_price_id
                  example: null
                item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for item_tiers
                  properties:
                    index:
                      type: array
                      description: |
                        The index or identifier of the [group](/docs/api/purchases)
                        to which this tier information belongs. This must be a value from the `purchase_items[index]`
                        array.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    item_price_id:
                      type: array
                      description: |
                        The unique ID of the item price to which this tier information belongs. This must be a value from the `purchase_items[item_price_id]`
                        array.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: |
                        The lowest value of quantity in this tier; this is zero for the lowest tier. For all other tiers, it is the same as `ending_unit_in_decimal`
                        of the very next lower tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The highest value of quantity in this tier. For all other tiers,it must be equal to the `starting_unit_in_decimal`
                        of the very next higher tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |
                        The per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the total price of the item. The currency units in which this value is expressed [depends](/docs/api/currencies)
                        on the type of currency.
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                  required:
                  - index
                  example: null
                shipping_addresses:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for shipping_addresses
                  properties:
                    first_name:
                      type: array
                      description: |
                        The first name of the contact. This parameter is `mandatory`
                        when providing shipping information.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 150
                        example: null
                      example: null
                    last_name:
                      type: array
                      description: |
                        The last name of the contact. This parameter is `mandatory`
                        when providing shipping information.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 150
                        example: null
                      example: null
                    email:
                      type: array
                      description: |
                        The email address.
                      items:
                        type: string
                        format: email
                        deprecated: false
                        maxLength: 70
                        example: null
                      example: null
                    company:
                      type: array
                      description: |
                        The company name.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 250
                        example: null
                      example: null
                    phone:
                      type: array
                      description: |
                        The phone number.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    line1:
                      type: array
                      description: |
                        Address line 1. This parameter is `mandatory`
                        when providing shipping information.
                      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: |
                        The name of the city. This parameter is `mandatory`
                        when providing shipping information.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    state:
                      type: array
                      description: |
                        The state/province name.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    state_code:
                      type: array
                      description: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ).
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    country:
                      type: array
                      description: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html).\n\
                        This parameter is `mandatory`\nwhen providing shipping information.\n\
                        \n**Note**:\nIf you enter an invalid country code, the system\
                        \ will return an error.  \n**Brexit**\n\nIf you have enabled\
                        \ [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in\
                        \ 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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://chromium-i18n.appspot.com/ssl-address).
                        This parameter is `mandatory`
                        when providing shipping information.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 20
                        example: null
                      example: null
                    validation_status:
                      type: array
                      items:
                        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: object
                  deprecated: false
                  description: |
                    Parameters for discounts
                  properties:
                    index:
                      type: array
                      description: "The index or identifier of the [group](/docs/api/purchases)\n\
                        to which this discount or coupon information belongs. This\
                        \ must be a value from the `purchase_items[index]` array.\
                        \ When not provided, the coupon is applied to the first invoice\
                        \ only; irrespective of the values set for [coupon.duration_type](/docs/api/coupons/coupon-object#duration_type)or\
                        \ [coupon.max_redemptions](/docs/api/coupons/coupon-object#max_redemptions).\
                        \  \n**See also:**\n[Applying discounts](/docs/api/purchases)\n"
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    coupon_id:
                      type: array
                      description: "The unique ID of a coupon to be applied to the\
                        \ group. Alternatively, you may provide a [coupon code](/docs/api/coupon_codes).\
                        \ Applicable only for [coupons](/docs/api/coupons).  \n**See\
                        \ also:**\n[Applying discounts](/docs/api/purchases)\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    percentage:
                      type: array
                      description: "The percentage of the discount. Applicable only\
                        \ for [manual discounts](/docs/api/discounts). For any given\
                        \ array index `i`, provide `discounts[percentage][i]` or `discounts[quantity][i]`\
                        \ or `discounts[amount][i]`  \n**See also:**\n[Applying discounts](/docs/api/purchases)\n"
                      items:
                        type: number
                        format: double
                        deprecated: false
                        maximum: 100
                        minimum: 0.01
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: "The discount quantity. Applicable only for [manual\
                        \ discounts](/docs/api/discounts). For any given array index\
                        \ `i`, provide `discounts[percentage][i]` or `discounts[quantity][i]`\
                        \ or `discounts[amount][i]`  \n**See also:**\n[Applying discounts](/docs/api/purchases)\n"
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    amount:
                      type: array
                      description: "The absolute value of the discount. The currency\
                        \ units in which this value is expressed [depends](/docs/api/currencies)\
                        \ on the type of currency. Applicable only for [manual discounts](/docs/api/discounts).\n\
                        \nFor any given array index `i`, provide `discounts[percentage][i]`\
                        \ or `discounts[quantity][i]` or `discounts[amount][i]`  \n\
                        **See also:**\n[Applying discounts](/docs/api/purchases)\n"
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    included_in_mrr:
                      type: array
                      description: |
                        For [manual discounts](/docs/api/discounts), set this to `false` if this manual discount should be excluded from monthly recurring revenue (MRR) calculations for the site. The following prerequisites must be met to allow this parameter to be passed:

                        * The feature must be [enabled in Chargebee](https://www.chargebee.com/docs/2.0/reporting.html#dashboards_flexible-mrr-calculation).
                        * The [site-level](https://www.chargebee.com/docs/2.0/reporting.html#chart_flexible-mrr-calculation) setting must be to include coupons in MRR calculations.

                        **See also:**
                        [Applying discounts](/docs/api/purchases)
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                  example: null
                subscription_info:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for subscription_info
                  properties:
                    index:
                      type: array
                      description: |
                        The index or identifier of the [group](/docs/api/purchases)
                        to which this subscription information belongs. This must be a value from the `purchase_items[index]`
                        array and the group must be a [subscription group](/docs/api/purchases)
                        .
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    subscription_id:
                      type: array
                      description: |
                        When specifying a [subscription group](/docs/api/purchases)
                        , this is the unique identifier of the [subscription](/docs/api/subscriptions)
                        to be created. This value must be unique for each subscription group.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles [set for the plan-item price](/docs/api/item_prices/item_price-object#billing_cycles)
                        is used.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    contract_term_billing_cycle_on_renewal:
                      type: array
                      description: |
                        Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as `billing_cycles`
                        or a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)
                        .
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 100
                        minimum: 1
                        example: null
                      example: null
                  required:
                  - index
                  example: null
                contract_terms:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for contract_terms
                  properties:
                    index:
                      type: array
                      description: |
                        The index number of the subscription/one-time group to which the item price is added. Provide a unique number between `0`
                        and `9`
                        (inclusive) for each group that is to be created. To increase this limit, contact Chargebee Support
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    action_at_term_end:
                      type: array
                      items:
                        type: string
                        default: renew
                        deprecated: false
                        description: |
                          Action to be taken when the contract term completes.

                          * renew -
                            * Contract term completes and a new contract term is started for the number of billing cycles specified in [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).
                            * The `action_at_term_end` for the new contract term is set to `renew`.
                          * renew_once -
                            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 [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).

                            * The `action_at_term_end` for the new contract term is set to `cancel`.
                          * evergreen - Contract term completes and the subscription renews.
                          * cancel - Contract term completes and subscription is canceled.
                        enum:
                        - renew
                        - evergreen
                        - cancel
                        - renew_once
                        example: null
                      example: null
                    cancellation_cutoff_period:
                      type: array
                      description: |
                        The number of days before [`contract_end`](/docs/api/contract_terms/contract_term-object#contract_end)
                        , 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.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                  required:
                  - index
                  example: null
              example: null
            encoding:
              billing_address:
                style: deepObject
                explode: true
              contract_terms:
                style: deepObject
                explode: true
              customer:
                style: deepObject
                explode: true
              discounts:
                style: deepObject
                explode: true
              item_tiers:
                style: deepObject
                explode: true
              purchase_items:
                style: deepObject
                explode: true
              shipping_addresses:
                style: deepObject
                explode: true
              subscription_info:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  estimate:
                    $ref: "#/components/schemas/Estimate"
                    description: |
                      Resource object representing estimate
                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}/payment_vouchers:
    get:
      tags:
      - customers
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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:
      tags:
      - invoices
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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_not\] = "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:
      tags:
      - payment_vouchers
      summary: Retrieve voucher data
      description: |
        Retrieves a voucher using the unique `payment_voucher_id`
        .
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - 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: |
                      Resource object representing payment_voucher
                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:
      tags:
      - payment_vouchers
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    Parameters for `invoice_allocations`
                  properties:
                    invoice_id:
                      type: array
                      description: |
                        The unique identifier of the invoice. You can pass multiple invoices IDs.
                      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: |
                      Resource object representing payment_voucher
                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:
      tags:
      - csv_tax_rules
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
      tags:
      - currencies
      summary: Add schedule
      description: |
        This API is used to schedule exchange rate modification for a `manual`
        `forex_type`
        currency.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    This parameter allows you to pass the exchange rate in decimal format. When `forex_type`
                    is `manual`
                    you have to set the exchange rate for additional currencies in `manual_exchange_rate`
                    parameter. A maximum of **nine**
                    decimal values are allowed to pass in this field.
                  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
                    description: |
                      Timestamp at which the scheduled exchange rate is to be updated on your site.
                    example: null
                  currency:
                    $ref: "#/components/schemas/Currency"
                    description: |
                      Resource object representing currency
                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:
      tags:
      - currencies
      summary: Add a new currency
      description: |
        This API is used to add a new currency to your Chargebee site. Prior to using this API, ensure that the [multi-currency feature](https://www.chargebee.com/docs/2.0/multi-currency-pricing.html#1-adding-and-managing-currencies)
        is enabled.
        If the `forex_type`
        is set to `manual`
        , you can specify the `manual_exchange_rate`
        . Additionally, the currency code provided must adhere to the three-letter ISO standard currency codes.
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    This represents the exchange rate type set for the currency.

                    * auto -
                      If `forex_type`
                      is `auto`
                      , conversion rate will be auto updated by Chargebee every day with third party providers (using external currency conversion providers)
                    * manual -
                      If `forex_type`
                      is `manual`
                      , 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
                  enum:
                  - manual
                  - auto
                  example: null
                manual_exchange_rate:
                  type: string
                  deprecated: false
                  description: |
                    This parameter allows you to pass the exchange rate in decimal format. When `forex_type`
                    is `manual`
                    you have to set the exchange rate for additional currencies in `manual_exchange_rate`
                    parameter. A maximum of **nine**
                    decimal values are allowed to pass in this field.
                  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: |
                      Resource object representing currency
                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:
      tags:
      - currencies
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
                  currency:
                    $ref: "#/components/schemas/Currency"
                    description: |
                      Resource object representing currency
                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:
      tags:
      - currencies
      summary: Update a currency
      description: |
        This API is used to update the configured currencies within your Chargebee site.
        Additionally, If the `forex_type`
        is set to `manual`
        , you can specify the `manual_exchange_rate`
        .
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    This represents the exchange rate type set for the currency.

                    * auto -
                      If `forex_type`
                      is `auto`
                      , conversion rate will be auto updated by Chargebee every day with third party providers (using external currency conversion providers)
                    * manual -
                      If `forex_type`
                      is `manual`
                      , 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
                  enum:
                  - manual
                  - auto
                  example: null
                manual_exchange_rate:
                  type: string
                  deprecated: false
                  description: |
                    This parameter allows you to pass the exchange rate in decimal format. When `forex_type`
                    is `manual`
                    you have to set the exchange rate for additional currencies in `manual_exchange_rate`
                    parameter. A maximum of **nine**
                    decimal values are allowed to pass in this field.
                  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: |
                      Resource object representing currency
                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:
      tags:
      - currencies
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
                    description: |
                      Timestamp at which the scheduled exchange rate is to be updated on your site.
                    example: null
                  currency:
                    $ref: "#/components/schemas/Currency"
                    description: |
                      Resource object representing currency
                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:
      tags:
      - currencies
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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: []
  /ramps/{ramp-id}:
    get:
      tags:
      - ramps
      summary: Retrieve a subscription ramp
      description: |
        Retrieves a specific subscription ramp.
      operationId: retrieve_a_ramp
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: ramp-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/ramp-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  ramp:
                    $ref: "#/components/schemas/Ramp"
                    description: |
                      Resource object representing ramp
                required:
                - ramp
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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}/create_ramp:
    post:
      tags:
      - subscriptions
      summary: Create a subscription ramp
      description: "Creates a ramp for a subscription.  \n**Note**\n\n* **Subscription\
        \ status** : You cannot create ramps for subscriptions in the `paused` or\
        \ `cancelled` [status](/docs/api/subscriptions/subscription-object#status).\n\
        * **Advance invoice** : You cannot create ramps for subscriptions that have\
        \ an [advance invoice schedule](/docs/api/advance_invoice_schedules).\n* **Upcoming\
        \ ramps limit** : A subscription can have a maximum of 12 upcoming ramps at\
        \ any given time, excluding deleted ramps. Upcoming ramps are ramps with `status`\
        \ as [scheduled](/docs/api/ramps/ramp-object#status).\n* **Total ramps limit**:\
        \ A subscription can have a maximum of 100 ramps at any given time, excluding\
        \ deleted ramps.\n* You cannot create a ramp for subscription, when ramps\
        \ are in draft status.\n"
      operationId: create_a_ramp
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
                effective_from:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: "The time when this ramp takes effect.  \n**Caution**\n\
                    \n* Ensure the time is within **five** years from the current\
                    \ time.\n* Ensure there is a minimum 24-hour interval between\
                    \ `effective_from` of two consecutive ramps.\n* If the subscription\
                    \ is scheduled to be paused or canceled in the future, ensure\
                    \ the time is not on or after [pause_date](/docs/api/subscriptions/subscription-object#pause_date)\
                    \ or [cancelled_at](/docs/api/subscriptions/subscription-object#cancelled_at).\n"
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    A brief summary of the pricing changes applied with this ramp.
                  maxLength: 250
                  example: null
                coupons_to_remove:
                  type: array
                  deprecated: false
                  description: "List of [coupons](/docs/api/coupons)\nremoved from\
                    \ the subscription through this ramp.  \n**Caution**\nEnsure this\
                    \ list does **not** include:\n\n* Coupons being added through\
                    \ this ramp.\n* Coupons already removed by a previous ramp.\n"
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                discounts_to_remove:
                  type: array
                  deprecated: false
                  description: "List of [discounts](/docs/api/discounts)\nremoved\
                    \ from the subscription through this ramp.  \n**Caution**\nEnsure\
                    \ this list does not include discounts already removed by a previous\
                    \ ramp.\n"
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                items_to_remove:
                  type: array
                  deprecated: false
                  description: "List of [item prices](/docs/api/item_prices)\nremoved\
                    \ from the subscription through this ramp.  \n**Caution**\nEnsure\
                    \ this list does **not** include:\n\n* Item prices being added\
                    \ or updated through this ramp.\n* Item prices already removed\
                    \ by a previous ramp.\n"
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                billing_configuration:
                  type: object
                  deprecated: false
                  properties:
                    po_number:
                      type: string
                      deprecated: false
                      maxLength: 100
                      example: null
                  example: null
                contract_term:
                  type: object
                  deprecated: false
                  description: |
                    An object that specifies the contract term details.
                  properties:
                    action_at_term_end:
                      type: string
                      default: renew
                      deprecated: false
                      description: |
                        Action to be taken when the contract term completes.

                        * evergreen - Contract term completes and the subscription renews.
                        * renew -
                          Used when you want to renew the contract term. Does the following:

                          * Contract term completes and a new contract term is started for the number of billing cycles specified in `renewal_billing_cycles`.
                          * The `action_at_term_end` for the new contract term is set to `renew`.
                        * renew_once -
                          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 `renewal_billing_cycles`.
                          * The `action_at_term_end` for the new contract term is set to `cancel`.
                        * cancel - Contract term completes and subscription is canceled.
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      - renew_once
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        The number of days before [contract_end](/docs/api/contract_terms/contract_term-object#contract_end)
                        , 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.
                      example: null
                    renewal_billing_cycles:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as [billing_cycles](/docs/api/contract_terms/contract_term-object#billing_cycle)
                        or a custom value depending on the [site configuration](https://www.chargebee.com/docs/billing/2.0/subscriptions/contract-terms#configuring-contract-terms)
                        .
                      example: null
                  example: null
                items_to_add:
                  type: object
                  deprecated: false
                  description: |
                    Details about the [item prices](/docs/api/item_prices)
                    added to the subscription through this ramp.
                  properties:
                    item_price_id:
                      type: array
                      description: "The unique identifier of the item price.  \n**Caution**\n\
                        \n* Ensure this list does **not** include:\n\n* Item prices\
                        \ updated or removed through this ramp.\n\n* Item prices already\
                        \ in the subscription or added by a previous ramp.\n\n* The\
                        \ ramp should not change the [billing period](/docs/api/item_prices/item_price-object#period)\
                        \ of the subscription if an upcoming ramp already exists after\
                        \ [effective_from](/docs/api/ramps/create-a-ramp#effective_from)\
                        \ time.\n\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        The quantity of the item purchased
                      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 item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        The price/per unit price of the item. When not provided, [the value set](/docs/api/item_prices/item-price-object)
                        for the item price is used. This is only applicable when the `pricing_model`
                        of the item price is `flat_fee`
                        or `per_unit`.
                        Also, it is only allowed when [price overriding](https://www.chargebee.com/docs/price-override.html)
                        is enabled for the site. The value depends on the [type of currency](/docs/api/currencies)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      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/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        For the plan-item price:
                        the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then [the value set](/docs/api/item_prices/item-price-object)
                        for the plan-item price is used.

                        For addon-item prices:
                        If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)
                        are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then [the value set under attached addons](/docs/api/attached_items/attached-item-object)
                        is used. Further, if that value is not provided, then [the value set for the addon-item price](/docs/api/item_prices/item-price-object)
                        is used.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    service_period_days:
                      type: array
                      description: |
                        The service period of the item in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 730
                        minimum: 1
                        example: null
                      example: null
                    charge_on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          When `charge_on_option`
                          option is set to `on_event`
                          , this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.

                          * plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                          * contract_termination -
                            when a contract term is [terminated](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option)
                            .
                          * subscription_trial_start - the time when the trial period of the subscription begins.
                          * subscription_activation -
                            the moment a subscription enters an `active`
                            or `non-renewing`
                            state. Also includes reactivations of canceled subscriptions.
                        enum:
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        Indicates if the charge-item is to be charged only once or each time the `charge_on_event`
                        occurs. This parameter only applies to charge-items.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    charge_on_option:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates when the charge-item is to be charged. This parameter only applies to charge-items.

                          * immediately - The item is charged immediately on being added to the subscription.
                          * on_event -
                            The item is charged at the occurrence of the event specified as `charge_on_event`
                            .
                        enum:
                        - immediately
                        - on_event
                        example: null
                      example: null
                  required:
                  - item_price_id
                  example: null
                items_to_update:
                  type: object
                  deprecated: false
                  description: |
                    Details about the [item prices](/docs/api/item_prices)
                    updated in the subscription through this ramp.
                  properties:
                    item_price_id:
                      type: array
                      description: "The unique identifier of the item price.  \n**Caution**\n\
                        Ensure this list:\n\n* Does not include any item price added\
                        \ or removed through this ramp.\n* Does not include any item\
                        \ price removed by a previous ramp.\n* Includes only item\
                        \ prices currently in the subscription or added by a previous\
                        \ ramp.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        The quantity of the item purchased
                      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 item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        The price/per unit price of the item. When not provided, [the value set](/docs/api/item_prices/item-price-object)
                        for the item price is used. This is only applicable when the `pricing_model`
                        of the item price is `flat_fee`
                        or `per_unit`.
                        Also, it is only allowed when [price overriding](https://www.chargebee.com/docs/price-override.html)
                        is enabled for the site. The value depends on the [type of currency](/docs/api/currencies)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      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/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        For the plan-item price:
                        the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then [the value set](/docs/api/item_prices/item-price-object)
                        for the plan-item price is used.

                        For addon-item prices:
                        If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)
                        are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then [the value set under attached addons](/docs/api/attached_items/attached-item-object)
                        is used. Further, if that value is not provided, then [the value set for the addon-item price](/docs/api/item_prices/item-price-object)
                        is used.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    service_period_days:
                      type: array
                      description: |
                        The service period of the item in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 730
                        minimum: 1
                        example: null
                      example: null
                    charge_on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          When `charge_on_option`
                          option is set to `on_event`
                          , this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.

                          * subscription_activation -
                            the moment a subscription enters an `active`
                            or `non-renewing`
                            state. Also includes reactivations of canceled subscriptions.
                          * subscription_trial_start - the time when the trial period of the subscription begins.
                          * contract_termination -
                            when a contract term is [terminated](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option)
                            .
                          * plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                        enum:
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        Indicates if the charge-item is to be charged only once or each time the `charge_on_event`
                        occurs. This parameter only applies to charge-items.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    charge_on_option:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates when the charge-item is to be charged. This parameter only applies to charge-items.

                          * immediately - The item is charged immediately on being added to the subscription.
                          * on_event -
                            The item is charged at the occurrence of the event specified as `charge_on_event`
                            .
                        enum:
                        - immediately
                        - on_event
                        example: null
                      example: null
                  required:
                  - item_price_id
                  example: null
                item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    **Note**
                    Allowed only when both of these conditions are met:

                    * Price overriding is enabled for the site.
                    * pricing_model of the item price is either tiered, volume, or stairstep.

                    Replaces the existing item_tiers for specific `item_price`s within the subscription. You must provide the complete tier set for any `item_price`, even if you're changing the price for only one tier.
                  properties:
                    item_price_id:
                      type: array
                      description: "The identifier of the `item_price`\nfor which\
                        \ the tier price is being overridden.  \n**Caution**\nThe\
                        \ identifier must correspond to an `item_price` listed in\
                        \ either `items_to_add` or `items_to_update`.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: |
                        The lowest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The highest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |
                        The overridden price of the tier. The value depends on the [type of currency](/docs/api/currencies)
                        .
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    pricing_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Pricing type for the tier.

                          * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                          * flat_fee -
                            Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                            pricing model, `pricing_type`
                            will be set to `flat_fee`
                            by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                          * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                        enum:
                        - per_unit
                        - flat_fee
                        - package
                        example: null
                      example: null
                    package_size:
                      type: array
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                  example: null
                coupons_to_add:
                  type: object
                  deprecated: false
                  description: |
                    Details about the [coupons](/docs/api/coupons)
                    added to the subscription through this ramp.
                  properties:
                    coupon_id:
                      type: array
                      description: "Unique ID of the coupon to be added.  \n**Caution**\n\
                        \n* Ensure this list does not include coupons being removed\
                        \ through this ramp.\n* [Coupon codes](/docs/api/coupon_codes)\
                        \ are not supported.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    apply_till:
                      type: array
                      description: |
                        The date till when the coupon can be applied. Applicable for `limited_period`
                        [coupons](/docs/api/coupons)
                        only.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
                discounts_to_add:
                  type: object
                  deprecated: false
                  description: |
                    Details about the [discounts](/docs/api/discounts)
                    added to the subscription through this ramp.
                  properties:
                    apply_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The amount on the invoice to which the discount is applied.

                          * invoice_amount -
                            The discount is applied to the invoice `sub_total`
                            .
                          * specific_item_price -
                            The discount is applied to the `invoice.line_item.amount`
                            that corresponds to the item price specified by `item_price_id`
                            .
                        enum:
                        - invoice_amount
                        - specific_item_price
                        example: null
                      example: null
                    duration_type:
                      type: array
                      items:
                        type: string
                        default: forever
                        deprecated: false
                        description: |
                          Specifies the time duration for which this discount is attached to the subscription.

                          * one_time -
                            The discount stays attached to the subscription till it is applied on an invoice **once**.
                            It is removed after that from the subscription.
                          * forever -
                            The discount is attached to the subscription and applied on the invoices till it is [explicitly removed](/docs/api/subscriptions/update-subscription-for-items#discounts_operation_type)
                            .
                          * 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 `period`
                            and `period_unit`
                            .
                        enum:
                        - one_time
                        - forever
                        - limited_period
                        example: null
                      example: null
                    percentage:
                      type: array
                      description: |
                        The percentage of the original amount that should be deducted from it.
                      items:
                        type: number
                        format: double
                        deprecated: false
                        maximum: 100
                        minimum: 0.01
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        The value of the discount. [depends on the kind of currency.](/docs/api/currencies)
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: "Specifies the number of free units provided for\
                        \ the item, without affecting the total quantity sold. When\
                        \ `discounts_to_add.quantity` is provided, the [`discounts_to_add.type`](/docs/api/ramps/ramp-object#discounts_to_add_type)\
                        \ is automatically set to `offer_quantity`.  \n**Constraints**\n\
                        \n* `discounts_to_add[item_price_id]` must belong to an item\
                        \ price with [`pricing_model`](/docs/api/item_prices#pricing_model)\
                        \ `per_unit`.\n* `discounts_to_add[apply_on]` must be `specific_item_price`.\n"
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    period:
                      type: array
                      description: |
                        The duration of time for which the discount is attached to the subscription, in `period_units`.
                        Applicable only when `duration_type`
                        is `limited_period`.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    period_unit:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The unit of time for `period`.
                          Applicable only when `duration_type`
                          is `limited_period`.

                          * week - A period of 7 days.
                          * year - A period of 1 calendar year.
                          * day - A period of 24 hours.
                          * month - A period of 1 calendar month.
                        enum:
                        - day
                        - week
                        - month
                        - year
                        example: null
                      example: null
                    included_in_mrr:
                      type: array
                      description: |
                        The discount is included in MRR calculations for your site. This attribute is only applicable when `duration_type`
                        is `one_time`
                        and when the [feature is enabled](https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation)
                        in Chargebee. Also, If the [site-level setting](https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation)
                        is to exclude one-time discounts from MRR calculations, this value is always returned `false`.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    item_price_id:
                      type: array
                      description: |
                        The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                        in the subscription to which the discount is to be applied. Relevant only when `apply_on`
                        = `specific_item_price`.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                  required:
                  - apply_on
                  - duration_type
                  example: null
              required:
              - effective_from
              example: null
            encoding:
              billing_configuration:
                style: deepObject
                explode: true
              contract_term:
                style: deepObject
                explode: true
              coupons_to_add:
                style: deepObject
                explode: true
              discounts_to_add:
                style: deepObject
                explode: true
              item_tiers:
                style: deepObject
                explode: true
              items_to_add:
                style: deepObject
                explode: true
              items_to_update:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  ramp:
                    $ref: "#/components/schemas/Ramp"
                    description: |
                      Resource object representing ramp
                required:
                - ramp
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /ramps:
    get:
      tags:
      - ramps
      summary: List subscription ramps
      description: "Lists the subscription ramps that match the criteria provided\
        \ in the filter parameters.  \n**Note**\nBy default, the ramps are returned\
        \ [sorted](/docs/api/ramps/list-ramps) in descending order (latest first)\
        \ by [updated_at](/docs/api/ramps/ramp-object#updated_at).\n"
      operationId: list_ramps
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: include_deleted
        in: query
        description: "Specifies whether to include deleted resources in the response.\
          \ Deleted resources are those with the [deleted](/docs/api/ramps/ramp-object#deleted)\
          \ attribute set to `true`.  \n**Caution**\n`status` or `effective_from`\
          \ filters must not be passed when `include_deleted` is set to `true`.\n\n\
          .\n"
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          example: null
      - name: status
        in: query
        description: "optional, enumerated string filter\n\nFilter subscription ramps\
          \ based on `status`\n.  \n**Caution**\n\n* The `subscription_id` filter\
          \ must be passed when filtering by `status`.\n* `status` filter should not\
          \ be passed when `include_deleted` is set to `true`.\n\nPossible values\
          \ are : scheduled, succeeded, failed.\n\n**Supported operators :**\nis,\
          \ in\n\n**Example →**\n*status\\[is\\] = \"SCHEDULED\"*\n"
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: SCHEDULED
          properties:
            in:
              type: string
              description: "* `scheduled` - Status of the subscription schedule on\
                \ creation. \n* `succeeded` - The execution status of the schedule\
                \ if success. \n* `failed` - The execution status of the schedule\
                \ if failed. \n* `draft` - Status of the subscription schedule considering\
                \ as draft"
              enum:
              - scheduled
              - succeeded
              - failed
              - draft
              pattern: "^\\[(scheduled|succeeded|failed|draft)(,(scheduled|succeeded|failed|draft))*\\\
                ]$"
              example: null
            is:
              type: string
              description: "* `scheduled` - Status of the subscription schedule on\
                \ creation. \n* `succeeded` - The execution status of the schedule\
                \ if success. \n* `failed` - The execution status of the schedule\
                \ if failed. \n* `draft` - Status of the subscription schedule considering\
                \ as draft"
              enum:
              - scheduled
              - succeeded
              - failed
              - draft
              example: null
      - name: subscription_id
        in: query
        description: "optional, string filter\n\nFilter subscription ramps based on\
          \ `subscription_id`\n.  \n**Caution**\nThis filter is mandatory when filtering\
          \ by `status` or `effective_from`.\n\n**Supported operators :**\nis, in\n\
          \n**Example →**\n*subscription_id\\[is\\] = \"8gsnbYfsMLds\"*\n"
        required: true
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: 8gsnbYfsMLds
          properties:
            in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
            is:
              type: string
              minLength: 1
              example: null
      - name: effective_from
        in: query
        description: "optional, timestamp(UTC) in seconds filter\n\nFilter subscription\
          \ ramps based on `effective_from`.  \n**Caution**\n\n* The `subscription_id`\
          \ filter must be passed when filtering by `effective_from`.\n* `effective_from`\
          \ filter should not be passed when `include_deleted` is set to `true`.\n\
          \n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n\
          *effective_from\\[after\\] = \"1435054328\"*\n"
        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\n\nFilter subscription\
          \ ramps based on `updated_at`\n.  \n**Tip**\nSpecify `sort_by` = `updated_at`\
          \ (whether `asc` oor `desc`) for a faster response when using this filter.\n\
          \n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n\
          *updated_at\\[after\\] = \"1435052328\"*\n"
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1435052328"
          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 :**
          effective_from, created_at, updated_at

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

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

          This will sort the result based on the 'effective_from' attribute in ascending(earliest first) order.
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
          properties:
            asc:
              type: string
              enum:
              - effective_from
              - updated_at
              example: null
            desc:
              type: string
              enum:
              - effective_from
              - updated_at
              example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        ramp:
                          $ref: "#/components/schemas/Ramp"
                          description: Resource object representing ramp
                      required:
                      - ramp
                      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: []
  /ramps/{ramp-id}/update:
    post:
      tags:
      - ramps
      summary: Update a subscription ramp
      description: |
        Updates an existing subscription ramp by replacing its current attribute values with the new parameters provided. When using this API to modify a ramp, make sure to include all the ramp's attributes as you would do during creation of the ramp with the necessary values updated.
        **Example: step-by-step flow**
        The following steps explains how to update effective_from value of an existing ramp.

        **Step 1: Retrieve current ramp values**

        1. Send a request to retrieve the current values of all parameters for the subscription ramp using [Retrieve a subscription ramp](/docs/api/ramps/retrieve-a-ramp) API.
        2. Review the response to get the current values of the ramp's attributes. Note down all the parameters and their values.

        **Step 2: Update ramp with new values**

        1. Prepare the request to update the ramp.
           * Update the effective_from value in the noted down attributes of ramp from the previous step.
           * Ensure all parameters, even those not being changed, are included in the request.
        2. Send the prepared request to [Update subscription ramp](/docs/api/ramps/update-a-subscription-ramp) API.
           * Verify the response object to ensure a successful subscription ramp update. If it returns an error, repeat step 1 again.

        **Note**

        * **Ramp status** : You cannot update a ramp in `succeeded` or `failed` [status](/docs/api/ramps/ramp-object#status).
        * **Advance invoice** : You cannot update ramps for subscriptions that have an [advance invoice schedule](/docs/api/advance_invoice_schedules).
      operationId: update_a_subscription_ramp
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: ramp-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/ramp-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                effective_from:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: "The time when this ramp takes effect.  \n**Caution**\n\
                    \n* Ensure the time is within **five** years from the current\
                    \ time.\n* Ensure there is a minimum 24-hour interval between\
                    \ `effective_from` of two consecutive ramps.\n* If the subscription\
                    \ is scheduled to be paused or canceled in the future, ensure\
                    \ the time is not on or after [pause_date](/docs/api/subscriptions/subscription-object#pause_date)\
                    \ or [cancelled_at](/docs/api/subscriptions/subscription-object#cancelled_at).\n"
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    A brief summary of the pricing changes applied with this ramp.
                  maxLength: 250
                  example: null
                coupons_to_remove:
                  type: array
                  deprecated: false
                  description: "List of [coupons](/docs/api/coupons)\nremoved from\
                    \ the subscription through this ramp.  \n**Caution**\nEnsure this\
                    \ list does **not** include:\n\n* Coupons being added through\
                    \ this ramp.\n* Coupons already removed by a previous ramp.\n"
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                discounts_to_remove:
                  type: array
                  deprecated: false
                  description: "List of [discounts](/docs/api/discounts)\nremoved\
                    \ from the subscription through this ramp.  \n**Caution**\nEnsure\
                    \ this list does not include discounts already removed by a previous\
                    \ ramp.\n"
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                items_to_remove:
                  type: array
                  deprecated: false
                  description: "List of [item prices](/docs/api/item_prices)\nremoved\
                    \ from the subscription through this ramp.  \n**Caution**\nEnsure\
                    \ this list does **not** include:\n\n* Item prices being added\
                    \ or updated through this ramp.\n* Item prices already removed\
                    \ by a previous ramp.\n"
                  items:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  example: null
                billing_configuration:
                  type: object
                  deprecated: false
                  properties:
                    po_number:
                      type: string
                      deprecated: false
                      maxLength: 100
                      example: null
                  example: null
                contract_term:
                  type: object
                  deprecated: false
                  description: |
                    An object that specifies the contract term details.
                  properties:
                    action_at_term_end:
                      type: string
                      default: renew
                      deprecated: false
                      description: |
                        Action to be taken when the contract term completes.

                        * evergreen - Contract term completes and the subscription renews.
                        * renew -
                          Used when you want to renew the contract term. Does the following:

                          * Contract term completes and a new contract term is started for the number of billing cycles specified in `renewal_billing_cycles`.
                          * The `action_at_term_end` for the new contract term is set to `renew`.
                        * renew_once -
                          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 `renewal_billing_cycles`.
                          * The `action_at_term_end` for the new contract term is set to `cancel`.
                        * cancel - Contract term completes and subscription is canceled.
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      - renew_once
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        The number of days before [contract_end](/docs/api/contract_terms/contract_term-object#contract_end)
                        , 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.
                      example: null
                    renewal_billing_cycles:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as [billing_cycles](/docs/api/contract_terms/contract_term-object#billing_cycle)

                        or a custom value depending on the
                        [site configuration](https://www.chargebee.com/docs/billing/2.0/subscriptions/contract-terms#configuring-contract-terms)
                        .
                      example: null
                  example: null
                items_to_add:
                  type: object
                  deprecated: false
                  description: |
                    Details about the [item prices](/docs/api/item_prices)
                    added to the subscription through this ramp.
                  properties:
                    item_price_id:
                      type: array
                      description: "The unique identifier of the item price.  \n**Caution**\n\
                        \n* Ensure this list does **not** include:\n\n* Item prices\
                        \ updated or removed through this ramp.\n\n* Item prices already\
                        \ in the subscription or added by a previous ramp.\n\n* The\
                        \ ramp should not change the [billing period](/docs/api/item_prices/item_price-object#period)\
                        \ of the subscription if an upcoming ramp already exists after\
                        \ [effective_from](/docs/api/ramps/create-a-ramp#effective_from)\
                        \ time.\n\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        The quantity of the item purchased
                      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 item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        The price/per unit price of the item. When not provided, [the value set](/docs/api/item_prices/item-price-object)
                        for the item price is used. This is only applicable when the `pricing_model`
                        of the item price is `flat_fee`
                        or `per_unit`.
                        Also, it is only allowed when [price overriding](https://www.chargebee.com/docs/price-override.html)
                        is enabled for the site. The value depends on the [type of currency](/docs/api/currencies)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      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/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        For the plan-item price:
                        the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then [the value set](/docs/api/item_prices/item-price-object)
                        for the plan-item price is used.

                        For addon-item prices:
                        If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)
                        are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then [the value set under attached addons](/docs/api/attached_items/attached-item-object)
                        is used. Further, if that value is not provided, then [the value set for the addon-item price](/docs/api/item_prices/item-price-object)
                        is used.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    service_period_days:
                      type: array
                      description: |
                        The service period of the item in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 730
                        minimum: 1
                        example: null
                      example: null
                    charge_on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          When `charge_on_option`
                          option is set to `on_event`
                          , this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.

                          * plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                          * contract_termination -
                            when a contract term is [terminated](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option)
                            .
                          * subscription_trial_start - the time when the trial period of the subscription begins.
                          * subscription_activation -
                            the moment a subscription enters an `active`
                            or `non-renewing`
                            state. Also includes reactivations of canceled subscriptions.
                        enum:
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        Indicates if the charge-item is to be charged only once or each time the `charge_on_event`
                        occurs. This parameter only applies to charge-items.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    charge_on_option:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates when the charge-item is to be charged. This parameter only applies to charge-items.

                          * immediately - The item is charged immediately on being added to the subscription.
                          * on_event -
                            The item is charged at the occurrence of the event specified as `charge_on_event`
                            .
                        enum:
                        - immediately
                        - on_event
                        example: null
                      example: null
                  required:
                  - item_price_id
                  example: null
                items_to_update:
                  type: object
                  deprecated: false
                  description: |
                    Details about the [item prices](/docs/api/item_prices)
                    updated in the subscription through this ramp.
                  properties:
                    item_price_id:
                      type: array
                      description: "The unique identifier of the item price.  \n**Caution**\n\
                        Ensure this list:\n\n* Does not include any item price added\
                        \ or removed through this ramp.\n* Does not include any item\
                        \ price removed by a previous ramp.\n* Includes only item\
                        \ prices currently in the subscription or added by a previous\
                        \ ramp.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        The quantity of the item purchased
                      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 item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    unit_price:
                      type: array
                      description: |
                        The price/per unit price of the item. When not provided, [the value set](/docs/api/item_prices/item-price-object)
                        for the item price is used. This is only applicable when the `pricing_model`
                        of the item price is `flat_fee`
                        or `per_unit`.
                        Also, it is only allowed when [price overriding](https://www.chargebee.com/docs/price-override.html)
                        is enabled for the site. The value depends on the [type of currency](/docs/api/currencies)
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    unit_price_in_decimal:
                      type: array
                      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/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    billing_cycles:
                      type: array
                      description: |
                        For the plan-item price:
                        the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then [the value set](/docs/api/item_prices/item-price-object)
                        for the plan-item price is used.

                        For addon-item prices:
                        If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)
                        are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then [the value set under attached addons](/docs/api/attached_items/attached-item-object)
                        is used. Further, if that value is not provided, then [the value set for the addon-item price](/docs/api/item_prices/item-price-object)
                        is used.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    service_period_days:
                      type: array
                      description: |
                        The service period of the item in days from the day of charge.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 730
                        minimum: 1
                        example: null
                      example: null
                    charge_on_event:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          When `charge_on_option`
                          option is set to `on_event`
                          , this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.

                          * subscription_activation -
                            the moment a subscription enters an `active`
                            or `non-renewing`
                            state. Also includes reactivations of canceled subscriptions.
                          * subscription_trial_start - the time when the trial period of the subscription begins.
                          * contract_termination -
                            when a contract term is [terminated](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option)
                            .
                          * plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                        enum:
                        - subscription_trial_start
                        - plan_activation
                        - subscription_activation
                        - contract_termination
                        example: null
                      example: null
                    charge_once:
                      type: array
                      description: |
                        Indicates if the charge-item is to be charged only once or each time the `charge_on_event`
                        occurs. This parameter only applies to charge-items.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    charge_on_option:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Indicates when the charge-item is to be charged. This parameter only applies to charge-items.

                          * immediately - The item is charged immediately on being added to the subscription.
                          * on_event -
                            The item is charged at the occurrence of the event specified as `charge_on_event`
                            .
                        enum:
                        - immediately
                        - on_event
                        example: null
                      example: null
                  required:
                  - item_price_id
                  example: null
                item_tiers:
                  type: object
                  deprecated: false
                  description: |
                    **Note**
                    Allowed only when both of these conditions are met:

                    * Price overriding is enabled for the site.
                    * pricing_model of the item price is either tiered, volume, or stairstep.

                    Replaces the existing item_tiers for specific `item_price`s within the subscription. You must provide the complete tier set for any `item_price`, even if you're changing the price for only one tier.
                  properties:
                    item_price_id:
                      type: array
                      description: "The identifier of the `item_price`\nfor which\
                        \ the tier price is being overridden.  \n**Caution**\nThe\
                        \ identifier must correspond to an `item_price` listed in\
                        \ either `items_to_add` or `items_to_update`.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    starting_unit:
                      type: array
                      description: |
                        The lowest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    ending_unit:
                      type: array
                      description: |
                        The highest value in the quantity tier.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        example: null
                      example: null
                    price:
                      type: array
                      description: |
                        The overridden price of the tier. The value depends on the [type of currency](/docs/api/currencies)
                        .
                      items:
                        type: integer
                        format: int64
                        default: 0
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    starting_unit_in_decimal:
                      type: array
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    ending_unit_in_decimal:
                      type: array
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the pricing_model is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 33
                        example: null
                      example: null
                    price_in_decimal:
                      type: array
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 39
                        example: null
                      example: null
                    pricing_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Pricing type for the tier.

                          * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                          * flat_fee -
                            Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                            pricing model, `pricing_type`
                            will be set to `flat_fee`
                            by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                          * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                        enum:
                        - per_unit
                        - flat_fee
                        - package
                        example: null
                      example: null
                    package_size:
                      type: array
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                  example: null
                coupons_to_add:
                  type: object
                  deprecated: false
                  description: |
                    Details about the [coupons](/docs/api/coupons)
                    added to the subscription through this ramp.
                  properties:
                    coupon_id:
                      type: array
                      description: "Unique ID of the coupon to be added.  \n**Caution**\n\
                        \n* Ensure this list does not include coupons being removed\
                        \ through this ramp.\n* [Coupon codes](/docs/api/coupon_codes)\
                        \ are not supported.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    apply_till:
                      type: array
                      description: |
                        The date till when the coupon can be applied. Applicable for `limited_period`
                        [coupons](/docs/api/coupons)
                        only.
                      items:
                        type: integer
                        format: unix-time
                        deprecated: false
                        example: null
                      example: null
                  example: null
                discounts_to_add:
                  type: object
                  deprecated: false
                  description: |
                    Details about the [discounts](/docs/api/discounts)
                    added to the subscription through this ramp.
                  properties:
                    apply_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The amount on the invoice to which the discount is applied.

                          * invoice_amount -
                            The discount is applied to the invoice `sub_total`
                            .
                          * specific_item_price -
                            The discount is applied to the `invoice.line_item.amount`
                            that corresponds to the item price specified by `item_price_id`
                            .
                        enum:
                        - invoice_amount
                        - specific_item_price
                        example: null
                      example: null
                    duration_type:
                      type: array
                      items:
                        type: string
                        default: forever
                        deprecated: false
                        description: |
                          Specifies the time duration for which this discount is attached to the subscription.

                          * one_time -
                            The discount stays attached to the subscription till it is applied on an invoice **once**.
                            It is removed after that from the subscription.
                          * forever -
                            The discount is attached to the subscription and applied on the invoices till it is [explicitly removed](/docs/api/subscriptions/update-subscription-for-items#discounts_operation_type)
                            .
                          * 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 `period`
                            and `period_unit`
                            .
                        enum:
                        - one_time
                        - forever
                        - limited_period
                        example: null
                      example: null
                    percentage:
                      type: array
                      description: |
                        The percentage of the original amount that should be deducted from it.
                      items:
                        type: number
                        format: double
                        deprecated: false
                        maximum: 100
                        minimum: 0.01
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        The value of the discount. [The format of this value](/docs/api/currencies)
                        depends on the kind of currency.
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: "Specifies the number of free units provided for\
                        \ the item, without affecting the total quantity sold. When\
                        \ `discounts_to_add.quantity` is provided, the [`discounts_to_add.type`](/docs/api/ramps/ramp-object#discounts_to_add_type)\
                        \ is automatically set to `offer_quantity`.  \n**Constraints**\n\
                        \n* `discounts_to_add[item_price_id]` must belong to an item\
                        \ price with [`pricing_model`](/docs/api/item_prices#pricing_model)\
                        \ `per_unit`.\n* `discounts_to_add[apply_on]` must be `specific_item_price`.\n"
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    period:
                      type: array
                      description: |
                        The duration of time for which the discount is attached to the subscription, in `period_units`.
                        Applicable only when `duration_type`
                        is `limited_period`.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    period_unit:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The unit of time for `period`.
                          Applicable only when `duration_type`
                          is `limited_period`.

                          * week - A period of 7 days.
                          * year - A period of 1 calendar year.
                          * day - A period of 24 hours.
                          * month - A period of 1 calendar month.
                        enum:
                        - day
                        - week
                        - month
                        - year
                        example: null
                      example: null
                    included_in_mrr:
                      type: array
                      description: |
                        The discount is included in MRR calculations for your site. This attribute is only applicable when `duration_type`
                        is `one_time`
                        and when the [feature is enabled](https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation)
                        in Chargebee. Also, If the [site-level setting](https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation)
                        is to exclude one-time discounts from MRR calculations, this value is always returned `false`.
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    item_price_id:
                      type: array
                      description: |
                        The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                        in the subscription to which the discount is to be applied. Relevant only when `apply_on`
                        = `specific_item_price`.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                  required:
                  - apply_on
                  - duration_type
                  example: null
              required:
              - effective_from
              example: null
            encoding:
              billing_configuration:
                style: deepObject
                explode: true
              contract_term:
                style: deepObject
                explode: true
              coupons_to_add:
                style: deepObject
                explode: true
              discounts_to_add:
                style: deepObject
                explode: true
              item_tiers:
                style: deepObject
                explode: true
              items_to_add:
                style: deepObject
                explode: true
              items_to_update:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  ramp:
                    $ref: "#/components/schemas/Ramp"
                    description: |
                      Resource object representing ramp
                required:
                - ramp
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /ramps/{ramp-id}/delete:
    post:
      tags:
      - ramps
      summary: Delete a subscription ramp
      description: "Deletes the specified subscription ramp. However, Chargebee only\
        \ allows deleting a ramp if it does not conflict with future ramps on the\
        \ subscription. The following checks are performed to ensure compatibility:\
        \  \n\n|               Condition                |                        \
        \                                   Restriction                          \
        \                                 |\n|----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|\n\
        | The ramp contains `items_to_add[]`     | The ramp cannot be deleted if any\
        \ of the items in `items_to_add[]` are scheduled to be updated or removed\
        \ in a subsequent ramp. |\n| The ramp contains `coupons_to_add[]`   | The\
        \ ramp cannot be deleted if any of the coupons in `coupons_to_add[]` are scheduled\
        \ to be removed in a subsequent ramp.        |\n| The ramp contains `discounts_to_add[]`\
        \ | The ramp cannot be deleted if any of the discounts in `discounts_to_add[]`\
        \ are scheduled to be removed in a subsequent ramp.    |\n\n"
      operationId: delete_a_ramp
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: ramp-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/ramp-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  ramp:
                    $ref: "#/components/schemas/Ramp"
                    description: |
                      Resource object representing ramp
                required:
                - ramp
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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_schedule_schemes/{payment-schedule-scheme-id}:
    get:
      tags:
      - payment_schedule_schemes
      summary: Retrieve a payment schedule scheme
      description: |
        This endpoint retrieves an existing payment schedule.
      operationId: retrieve_a_payment_schedule_scheme
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: payment-schedule-scheme-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/payment-schedule-scheme-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  payment_schedule_scheme:
                    $ref: "#/components/schemas/PaymentScheduleScheme"
                    description: |
                      Resource object representing payment_schedule_scheme
                required:
                - payment_schedule_scheme
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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_schedule_schemes:
    get:
      tags:
      - payment_schedule_schemes
      summary: List payment schedule schemes
      description: |
        Returns a list of payment schedule schemes that match **all** the specified filter conditions. The list is sorted by `id` in descending order. Use `limit` and `offset` to paginate through the results.
      operationId: list_payment_schedule_schemes
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: id
        in: query
        description: |
          optional, string filter

          An auto-generated unique identifier for the payment schedule scheme.
          **Supported operators :**
          is, is_not, starts_with, in, not_in

          **Example →**
          *id\[is\] = "scheme-id"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: scheme-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
            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

          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\] = "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:
                        payment_schedule_scheme:
                          $ref: "#/components/schemas/PaymentScheduleScheme"
                          description: Resource object representing payment_schedule_scheme
                      required:
                      - payment_schedule_scheme
                      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:
      tags:
      - payment_schedule_schemes
      summary: Create a payment schedule scheme
      description: |
        Creates a payment schedule scheme. After creating a payment schedule scheme, you can use it to generate payment schedules for multiple invoices.
      operationId: create_a_payment_schedule_scheme
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                number_of_schedules:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    Specifies the total number of payment schedules for the invoice. The maximum `number_of_schedules`
                    varies based on the `period_unit`
                    : - **Day**: Up to 30 schedules

                    * **Week**: Up to 52 schedules
                    * **Month**: Up to 12 schedules
                  maximum: 52
                  minimum: 1
                  example: null
                period_unit:
                  type: string
                  deprecated: false
                  description: |
                    Defines the time unit for intervals between payment schedules. Possible values are: day, week, and month.

                    * month - When the time unit for intervals between payment schedules is set as month
                    * week - When the time unit for intervals between payment schedules is set as week
                    * day - When the time unit for intervals between payment schedules is set as day
                  enum:
                  - day
                  - week
                  - month
                  example: null
                period:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The time period between the effective dates of two consecutive payment schedules, expressed in period_units. Use this parameter to have fixed intervals between payment schedules. The maximum `period`
                    varies based on the `period_unit`
                    : - **Day**: Up to 30 days

                    * **Week**: Up to 6 weeks
                    * **Month**: Up to 6 months
                  maximum: 30
                  minimum: 1
                  example: null
                name:
                  type: string
                  deprecated: false
                  description: |
                    The name of a payment schedule scheme.
                  maxLength: 100
                  example: null
                flexible_schedules:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for flexible_schedules
                  properties:
                    period:
                      type: array
                      description: |
                        The interval after which this payment schedule should be collected.
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        maximum: 52
                        minimum: 0
                        example: null
                      example: null
                    amount_percentage:
                      type: array
                      description: |
                        The percentage amount that this specific payment schedule should collect.
                      items:
                        type: number
                        format: decimal
                        deprecated: false
                        maximum: 100
                        minimum: 1
                        example: null
                      example: null
                  example: null
              required:
              - name
              - number_of_schedules
              - period_unit
              example: null
            encoding:
              flexible_schedules:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  payment_schedule_scheme:
                    $ref: "#/components/schemas/PaymentScheduleScheme"
                    description: |
                      Resource object representing payment_schedule_scheme
                required:
                - payment_schedule_scheme
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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_schedule_schemes/{payment-schedule-scheme-id}/delete:
    post:
      tags:
      - payment_schedule_schemes
      summary: Delete a payment schedule scheme
      description: |
        This endpoint deletes a payment schedules created for an invoice.
      operationId: delete_a_payment_schedule_scheme
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: payment-schedule-scheme-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/payment-schedule-scheme-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  payment_schedule_scheme:
                    $ref: "#/components/schemas/PaymentScheduleScheme"
                    description: |
                      Resource object representing payment_schedule_scheme
                required:
                - payment_schedule_scheme
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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:
      tags:
      - pc2_migrations
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
      tags:
      - pc2_migrations
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
    post:
      tags:
      - pc2_migrations
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
      tags:
      - pc2_migrations
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
      tags:
      - pc2_migration_item_families
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
      tags:
      - pc2_migration_item_families
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
                  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:
      tags:
      - pc2_migration_item_families
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
      tags:
      - pc2_migration_item_families
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - 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:
      tags:
      - pc2_migration_item_families
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
      tags:
      - pc2_migration_items
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
                  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:
      tags:
      - pc2_migration_items
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
      tags:
      - pc2_migration_items
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
      tags:
      - pc2_migration_items
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - 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:
      tags:
      - pc2_migration_items
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
      tags:
      - pc2_migration_items
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - 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:
      tags:
      - pc2_migration_item_prices
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - 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:
      tags:
      - pc2_migration_item_prices
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
      tags:
      - pc2_migration_item_prices
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
                  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:
      tags:
      - pc2_migration_item_prices
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: []
  /pricing_page_sessions/create_for_existing_subscription:
    post:
      tags:
      - pricing_page_sessions
      summary: Create pricing page for existing subscription
      description: "This endpoint streamlines the generation of a pricing page session\
        \ to enable subscription [upgrade](https://www.chargebee.com/docs/2.0/proration.html#introduction_proration)\n\
        , and [downgrade](https://www.chargebee.com/docs/2.0/proration.html#introduction_proration)\n\
        workflows using Chargebee's hosted pricing pages ([Atomic Pricing](https://www.atomicpricing.com/)\n\
        ). By providing a subscription ID as a parameter, you will obtain a hosted\
        \ pricing page session URL.  \nNote: [Full access key](https://www.chargebee.com/docs/api_keys.html#types-of-api-keys_full-access-key)\n\
        authentication is needed for this API request.\n"
      operationId: create_pricing_page_for_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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                redirect_url:
                  type: string
                  deprecated: false
                  description: |
                    The customers will be redirected to this URL upon successful checkout.
                  maxLength: 250
                  example: null
                custom:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    JSON object of custom attributes (key-value pairs) used for pricing page targeting or content. [Configure](https://www.chargebee.com/docs/retention/settings-and-installation/chargebee-retention-field-mappings) custom attributes in the dashboard.
                  example: null
                pricing_page:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for pricing page
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: "The unique identifier of the pricing table for\
                        \ which the hosted page is created. See [documentation](https://www.chargebee.com/docs/growth/offers/customize-pricing-table#obtain-the-pricing-table-id)\
                        \ to obtain the pricing table id from Chargebee Growth. If\
                        \ you want the pricing table to be auto-selected based on\
                        \ your [Play configuration](https://www.chargebee.com/docs/growth/plays/plays-overview)\
                        \ in Chargebee Growth, do not pass this parameter.  \n\n**Required\
                        \ if**\nYou are on the legacy version of Pricing Tables (i.e.\
                        \ Atomic Pricing). See [documentation](https://www.chargebee.com/docs/billing/2.0/hosted-capabilities/customize-pricing-table#obtain-the-site-id-and-pricing-table-id)\
                        \ to obtain the pricing table id.\n\n\n"
                      maxLength: 50
                      example: null
                  example: null
                subscription:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    Parameters for subscription
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        The unique identifier of an existing subscription for which the hosted pricing page is created.
                      maxLength: 50
                      example: null
                  required:
                  - id
                  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: |
                        Action to be taken when the contract term completes.

                        * evergreen - Contract term completes and the subscription renews.
                        * cancel - Contract term completes and subscription is canceled.
                        * renew -
                          * Contract term completes and a new contract term is started for the default number of billing cycles.
                          * The `action_at_term_end` for the new contract term is set to `renew`.
                        * renew_once -
                          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 [`contract_term_billing_cycle_on_renewal`](/docs/api/subscriptions/create-subscription-for-items#contract_term_billing_cycle_on_renewal).
                          * The `action_at_term_end` for the new contract term is set to `cancel`.
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      - renew_once
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      default: 0
                      deprecated: false
                      description: |
                        The number of days before [`contract_end`](/docs/api/contract_terms/contract_term-object#contract_end)
                        , 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.
                      example: null
                  example: null
                discounts:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for discounts
                  properties:
                    apply_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: "The amount on the invoice to which the discount\
                          \ is applied.\n\n* invoice_amount -\n  The discount is applied\
                          \ to the invoice `sub_total`.  \n  **Note:**\n  This enum\
                          \ value is not supported for `pricing_page_sessions` resource,\
                          \ soon this value will be available for this resource. For\
                          \ more details please reach out to [atomic-pricing@chargebee.com](mailto:atomic-pricing@chargebee.com)\n\
                          * specific_item_price -\n  The discount is applied to the\
                          \ `invoice.line_item.amount`\n  that corresponds to the\
                          \ item price specified by `item_price_id`\n  .\n"
                        enum:
                        - invoice_amount
                        - specific_item_price
                        example: null
                      example: null
                    duration_type:
                      type: array
                      items:
                        type: string
                        default: forever
                        deprecated: false
                        description: |
                          Specifies the time duration for which this discount is attached to the subscription.

                          * forever -
                            The discount is attached to the subscription and applied on the invoices till it is [explicitly removed](/docs/api/subscriptions/update-subscription-for-items#discounts_operation_type)
                            .
                          * one_time -
                            The discount stays attached to the subscription till it is applied on an invoice **once**.
                            It is removed after that from the subscription.
                          * 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 `period`
                            and `period_unit`
                            .
                        enum:
                        - one_time
                        - forever
                        - limited_period
                        example: null
                      example: null
                    percentage:
                      type: array
                      description: |
                        The percentage of the original amount that should be deducted from it.
                      items:
                        type: number
                        format: double
                        deprecated: false
                        maximum: 100
                        minimum: 0.01
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        The value of the discount. The format of this value depends on the kind of [currency](/docs/api/currencies)
                        you want to use for a discount. This is only applicable when [`type`](/docs/api/discounts/discount-object#type)
                        is `fixed_amount`
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    period:
                      type: array
                      description: |
                        The duration of time for which the discount is attached to the subscription, in `period_units`.
                        Applicable only when `duration_type`
                        is `limited_period`
                        .
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    period_unit:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The unit of time for `period`.
                          Applicable only when `duration_type`
                          is `limited_period`
                          .

                          * day - A period of 24 hours.
                          * month - A period of 1 calendar month.
                          * year - A period of 1 calendar year.
                          * week - A period of 7 days.
                        enum:
                        - day
                        - week
                        - month
                        - year
                        example: null
                      example: null
                    included_in_mrr:
                      type: array
                      description: |
                        The discount is included in MRR calculations for your site. This attribute is only applicable when `duration_type`
                        is `one_time`
                        and when the [feature is enabled](https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation)
                        in Chargebee. Also, If the [site-level setting](https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation)
                        is to exclude one-time discounts from MRR calculations, this value is always returned `false`
                        .
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    item_price_id:
                      type: array
                      description: |
                        The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                        in the subscription to which the discount is to be applied. Relevant only when `apply_on`
                        = `specific_item_price`
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Specifies the number of free units provided for the item, without affecting the total quantity sold
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    label:
                      type: array
                      description: |
                        Label for the discount
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                  required:
                  - duration_type
                  example: null
              example: null
            encoding:
              contract_term:
                style: deepObject
                explode: true
              discounts:
                style: deepObject
                explode: true
              pricing_page:
                style: deepObject
                explode: true
              subscription:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  pricing_page_session:
                    $ref: "#/components/schemas/PricingPageSession"
                    description: |
                      Resource object representing pricing_page_session
                required:
                - pricing_page_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: []
  /pricing_page_sessions/create_for_new_subscription:
    post:
      tags:
      - pricing_page_sessions
      summary: Create pricing page for new subscription
      description: "This endpoint streamlines the generation of a pricing page session\
        \ to enable new subscription creation workflows using Chargebee's hosted pricing\
        \ pages ([Atomic Pricing](https://www.atomicpricing.com/)\n). By providing\
        \ a subscription ID and/or customer ID as a parameter, you'll obtain a pricing\
        \ page session URL.  \nNote: [Full access key](https://www.chargebee.com/docs/api_keys.html#types-of-api-keys_full-access-key)\n\
        authentication is needed for this API request.\n"
      operationId: create_pricing_page_for_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                redirect_url:
                  type: string
                  deprecated: false
                  description: |
                    The customers will be redirected to this URL upon successful checkout.
                  maxLength: 250
                  example: null
                business_entity_id:
                  type: string
                  deprecated: false
                  description: |
                    Sets the [context](/docs/api/business_entities) for this operation to the [business entity](/docs/api/business_entities) specified. Applicable only when multiple business entities have been created for the site. When this parameter is provided, new subscription and customer resources are created within the business entity.
                  maxLength: 50
                  example: null
                brand_id:
                  type: string
                  deprecated: false
                  description: "The unique ID of the [brand](/docs/api/brands) this\
                    \ pricing page session should be linked to. Applicable only when\
                    \ multiple brands have been created for the site. The customer\
                    \ and subscription created through the session are linked to the\
                    \ same brand. An alternative way of passing this parameter is\
                    \ by means of the `chargebee-brand-id` custom HTTP header; when\
                    \ both are provided, they must specify the same brand.  \n**Default\
                    \ behavior**\n\n* When not provided, the default brand defined\
                    \ for the site is used.\n"
                  maxLength: 50
                  example: null
                auto_select_local_currency:
                  type: boolean
                  default: false
                  deprecated: false
                  description: |
                    * **`false`:** The first currency in the dropdown list is selected.
                    * **`true`:** Automatically determines the currency based on the visitor's geolocation. For example, if the visitor is from the United States and this flag is enabled, USD is selected as the currency-if it's available on the pricing page. Similarly, if the visitor is from India, INR is selected. If the visitor's country currency isn't available, the first currency in the dropdown list is selected.
                  example: null
                custom:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    JSON object of custom attributes (key-value pairs) used for pricing page targeting or content. [Configure](https://www.chargebee.com/docs/retention/settings-and-installation/chargebee-retention-field-mappings) custom attributes in the dashboard.
                  example: null
                pricing_page:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for pricing page
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: "The unique identifier of the pricing table for\
                        \ which the hosted page is created. See [documentation](https://www.chargebee.com/docs/growth/offers/customize-pricing-table#obtain-the-pricing-table-id)\
                        \ to obtain the pricing table id from Chargebee Growth. If\
                        \ you want the pricing table to be auto-selected based on\
                        \ your [Play configuration](https://www.chargebee.com/docs/growth/plays/plays-overview)\
                        \ in Chargebee Growth, do not pass this parameter.  \n**Required\
                        \ if**\n\n* You are on the legacy version of Pricing Tables\
                        \ (i.e. Atomic Pricing). See [documentation](https://www.chargebee.com/docs/billing/2.0/hosted-capabilities/customize-pricing-table#obtain-the-site-id-and-pricing-table-id)\
                        \ to obtain the pricing table id.\n* Chargebee Growth is enabled\
                        \ for your site and either `customer[id]` is not provided\
                        \ or it does not identify an existing customer.\n"
                      maxLength: 50
                      example: null
                  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
                  example: null
                customer:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    Parameters for customer
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: "The unique ID of the customer for which this `hosted_page`\n\
                        should be created. When not provided, a new customer is created\
                        \ with the ID set to the value provided for `subscription[id]`.\n\
                        If `subscription[id]`\nis unavailable, then the customer ID\
                        \ is autogenerated.  \n**Required if**\n\n* Chargebee Growth\
                        \ is enabled for your site and `pricing_page[id]` is not provided.\
                        \  \n**Constraints**\n\n* For Chargebee Growth auto-selection,\
                        \ when `pricing_page[id]` is not provided, must identify an\
                        \ existing customer in Chargebee. If the customer does not\
                        \ exist, the API returns a `resource_not_found` error.\n"
                      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
                  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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada and India If `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code)
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ).
                      maxLength: 50
                      example: null
                    state:
                      type: string
                      deprecated: false
                      description: |
                        The state/province name. Is set by Chargebee automatically for US, Canada and India If `state_code`
                        is provided.
                      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: "The billing address country of the customer. Must\
                        \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                        .\n\n**Note**:\nIf you enter an invalid country code, the\
                        \ system will return an error.  \n**Brexit**\n\nIf you have\
                        \ enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                        \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                        \ the Brexit configuration, then `XI` (the code for **United\
                        \ Kingdom - Northern Ireland**) is available as an option.\n"
                      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
                      default: renew
                      deprecated: false
                      description: |
                        Action to be taken when the contract term completes.

                        * evergreen - Contract term completes and the subscription renews.
                        * renew -
                          * Contract term completes and a new contract term is started for the default number of billing cycles.
                          * The `action_at_term_end` for the new contract term is set to `renew`.
                        * renew_once -
                          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 [`contract_term_billing_cycle_on_renewal`](/docs/api/subscriptions/create-subscription-for-items#contract_term_billing_cycle_on_renewal).
                          * The `action_at_term_end` for the new contract term is set to `cancel`.
                        * cancel - Contract term completes and subscription is canceled.
                      enum:
                      - renew
                      - evergreen
                      - cancel
                      - renew_once
                      example: null
                    cancellation_cutoff_period:
                      type: integer
                      format: int32
                      default: 0
                      deprecated: false
                      description: |
                        The number of days before [`contract_end`](/docs/api/contract_terms/contract_term-object#contract_end)
                        , 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.
                      example: null
                  example: null
                discounts:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for discounts
                  properties:
                    apply_on:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: "The amount on the invoice to which the discount\
                          \ is applied.\n\n* invoice_amount -\n  The discount is applied\
                          \ to the invoice `sub_total`.  \n  **Note:**\n  This enum\
                          \ value is not supported for `pricing_page_sessions` resource,\
                          \ soon this value will be available for this resource. For\
                          \ more details please reach out to [atomic-pricing@chargebee.com](mailto:atomic-pricing@chargebee.com)\n\
                          * specific_item_price -\n  The discount is applied to the\
                          \ `invoice.line_item.amount`\n  that corresponds to the\
                          \ item price specified by `item_price_id`\n  .\n"
                        enum:
                        - invoice_amount
                        - specific_item_price
                        example: null
                      example: null
                    duration_type:
                      type: array
                      items:
                        type: string
                        default: forever
                        deprecated: false
                        description: |
                          Specifies the time duration for which this discount is attached to the subscription.

                          * forever -
                            The discount is attached to the subscription and applied on the invoices till it is [explicitly removed](/docs/api/subscriptions/update-subscription-for-items#discounts_operation_type)
                            .
                          * one_time -
                            The discount stays attached to the subscription till it is applied on an invoice **once**.
                            It is removed after that from the subscription.
                          * 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 `period`
                            and `period_unit`
                            .
                        enum:
                        - one_time
                        - forever
                        - limited_period
                        example: null
                      example: null
                    percentage:
                      type: array
                      description: |
                        The percentage of the original amount that should be deducted from it.
                      items:
                        type: number
                        format: double
                        deprecated: false
                        maximum: 100
                        minimum: 0.01
                        example: null
                      example: null
                    amount:
                      type: array
                      description: |
                        The value of the discount. The format of this value depends on the kind of [currency](/docs/api/currencies)
                        you want to use for a discount. This is only applicable when [`type`](/docs/api/discounts/discount-object#type)
                        is `fixed_amount`
                        .
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        minimum: 0
                        example: null
                      example: null
                    period:
                      type: array
                      description: |
                        The duration of time for which the discount is attached to the subscription, in `period_units`.
                        Applicable only when `duration_type`
                        is `limited_period`
                        .
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    period_unit:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The unit of time for `period`.
                          Applicable only when `duration_type`
                          is `limited_period`
                          .

                          * day - A period of 24 hours.
                          * year - A period of 1 calendar year.
                          * week - A period of 7 days.
                          * month - A period of 1 calendar month.
                        enum:
                        - day
                        - week
                        - month
                        - year
                        example: null
                      example: null
                    included_in_mrr:
                      type: array
                      description: |
                        The discount is included in MRR calculations for your site. This attribute is only applicable when `duration_type`
                        is `one_time`
                        and when the [feature is enabled](https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation)
                        in Chargebee. Also, If the [site-level setting](https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation)
                        is to exclude one-time discounts from MRR calculations, this value is always returned `false`
                        .
                      items:
                        type: boolean
                        deprecated: false
                        example: null
                      example: null
                    item_price_id:
                      type: array
                      description: |
                        The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                        in the subscription to which the discount is to be applied. Relevant only when [`apply_on`](/docs/api/discounts/discount-object#apply_on)
                        is `specific_item_price`
                        .
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    quantity:
                      type: array
                      description: |
                        Specifies the number of free units provided for the item, without affecting the total quantity sold
                      items:
                        type: integer
                        format: int32
                        deprecated: false
                        minimum: 1
                        example: null
                      example: null
                    label:
                      type: array
                      description: |
                        Label for the discount
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                  required:
                  - duration_type
                  example: null
              example: null
            encoding:
              billing_address:
                style: deepObject
                explode: true
              contract_term:
                style: deepObject
                explode: true
              customer:
                style: deepObject
                explode: true
              discounts:
                style: deepObject
                explode: true
              pricing_page:
                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:
                  pricing_page_session:
                    $ref: "#/components/schemas/PricingPageSession"
                    description: |
                      Resource object representing pricing_page_session
                required:
                - pricing_page_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_pc_meta_records:
    get:
      tags:
      - site_pc_meta_records
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - 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: []
  /omnichannel_subscriptions/{omnichannel-subscription-id}/move:
    post:
      tags:
      - omnichannel_subscriptions
      summary: Move an omnichannel subscription
      description: |
        Moves an `omnichannel_subscription` to another customer in Chargebee.

        ### Prerequisites

        * The target customer must already exist in Chargebee (or be creatable via your usual customer APIs before calling this operation).
        * The omnichannel subscription must already be recorded in Chargebee.

        ### Impacts

        * Updates the omnichannel subscription's `customer_id` and related records to the target customer.
        * Triggers the [`omnichannel_subscription_moved_in`](/docs/api/events/webhook/omnichannel_subscription_moved_in) webhook with the new customer details.

        This operation does **not** change the underlying Apple or Google purchase; it only reassigns ownership inside Chargebee.
      operationId: move_an_omnichannel_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: omnichannel-subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/omnichannel-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: |
                    Specifies the unique ID of the `customer`
                    resource to which the subscription will be moved.
                  maxLength: 50
                  example: null
              required:
              - to_customer_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  omnichannel_subscription:
                    $ref: "#/components/schemas/OmnichannelSubscription"
                    description: |
                      Resource object representing Omnichannel subscription
                required:
                - omnichannel_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: []
  /omnichannel_subscriptions/{omnichannel-subscription-id}:
    get:
      tags:
      - omnichannel_subscriptions
      summary: Retrieve an omnichannel subscription
      description: |
        Retrieves an `omnichannel_subscription` by its Chargebee `id`.

        You can obtain the ID from:

        * A successful [record a purchase](/docs/api/recorded_purchases/record-a-purchase) response (`linked_omnichannel_subscriptions`)
        * The [list omnichannel subscriptions](/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions) API
        * Omnichannel webhook events such as `omnichannel_subscription_created`
      operationId: retrieve_an_omnichannel_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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: omnichannel-subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/omnichannel-subscription-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  omnichannel_subscription:
                    $ref: "#/components/schemas/OmnichannelSubscription"
                    description: |
                      Resource object representing Omnichannel subscription
                required:
                - omnichannel_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: []
  /omnichannel_subscriptions/{omnichannel-subscription-id}/omnichannel_transactions:
    get:
      tags:
      - omnichannel_subscriptions
      summary: List omnichannel transactions of an omnichannel subscription
      description: |
        Returns the list of [`omnichannel_transaction`](/docs/api/omnichannel_transactions) objects associated with the specified `omnichannel_subscription`, including the initial purchase and subsequent renewals when available.

        **Apple App Store** : Each transaction's `id_at_source` is the App Store **Transaction ID** . Price and `transacted_at` are typically present.

        **Google Play Store** : Each transaction's `id_at_source` is the Google Play **Order ID** (typically `GPA....`), which differs from the parent subscription's purchase-token `id_at_source`. Price and `transacted_at` may be present depending on the data available from Google for that transaction.
      operationId: list_omnichannel_transactions_of_an_omnichannel_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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: omnichannel-subscription-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/omnichannel-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
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        omnichannel_transaction:
                          $ref: "#/components/schemas/OmnichannelTransaction"
                          description: Resource object representing omnichannel_transaction
                      required:
                      - omnichannel_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: []
  /omnichannel_subscriptions:
    get:
      tags:
      - omnichannel_subscriptions
      summary: List omnichannel subscriptions
      description: |
        Returns a list of `omnichannel_subscription` objects. Filter by Chargebee `id`, store-native `id_at_source`, `customer_id`, `source`, purchase/update timestamps, or nested item attributes.

        **Apple App Store** : Filter `id_at_source` with the original purchase **Transaction ID**.

        **Google Play Store** : Filter `id_at_source` with the subscription **purchase token** . Google may issue a new token after certain subscription changes; Chargebee updates `id_at_source` to the latest token, so use the current token when filtering.
      operationId: list_omnichannel_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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: source
        in: query
        description: |
          optional, enumerated string filter

          To filter based on OmnichannelSubscription Source. Possible values are : apple_app_store, google_play_store.

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

          **Example →**
          *source\[is_not\] = "apple_app_store"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: apple_app_store
          properties:
            is:
              type: string
              description: |-
                * `apple_app_store` - Source of the app is apple app store
                * `google_play_store` - Source of the app is google play store
              enum:
              - apple_app_store
              - google_play_store
              example: null
            is_not:
              type: string
              description: |-
                * `apple_app_store` - Source of the app is apple app store
                * `google_play_store` - Source of the app is google play store
              enum:
              - apple_app_store
              - google_play_store
              example: null
            in:
              type: string
              description: |-
                * `apple_app_store` - Source of the app is apple app store
                * `google_play_store` - Source of the app is google play store
              enum:
              - apple_app_store
              - google_play_store
              pattern: "^\\[(apple_app_store|google_play_store)(,(apple_app_store|google_play_store))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |-
                * `apple_app_store` - Source of the app is apple app store
                * `google_play_store` - Source of the app is google play store
              enum:
              - apple_app_store
              - google_play_store
              pattern: "^\\[(apple_app_store|google_play_store)(,(apple_app_store|google_play_store))*\\\
                ]$"
              example: null
      - name: customer_id
        in: query
        description: |
          optional, string filter

          Chargebee Customer External Identifier.

          **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: id
        in: query
        description: |
          optional, string filter

          A unique and immutable identifier for the omnichannel subscription.

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

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

          The identifier of the subscription in the [`source`](omnichannel_subscriptions#omnichannel_subscriptions_source).

          **Apple App Store** : The original purchase **Transaction ID**.

          **Google Play Store** : The subscription **purchase token** . Google may issue a new token after certain subscription changes; Chargebee updates `id_at_source` to the latest token.

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

          **Example →**
          *id_at_source\[is\] = "2000000123456789"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "2000001162945130"
          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 (UTC) indicating when the subscription was last updated.

          **Supported operators :**
          after, before, on, between

          **Example →**
          *updated_at\[after\] = "1777902633"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1777556762"
          properties:
            before:
              type: string
              format: unix-time
              pattern: "^\\d{10}$"
              example: null
            between:
              type: string
              pattern: "^\\[\\d{10},\\d{10}\\]$"
              example: null
            "on":
              type: string
              format: unix-time
              pattern: "^\\d{10}$"
              example: null
            after:
              type: string
              format: unix-time
              pattern: "^\\d{10}$"
              example: null
      - name: purchased_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          Timestamp (UTC) when the subscription was originally purchased in the respective marketplace (initial purchase).

          **Supported operators :**
          after, before, on, between

          **Example →**
          *purchased_at\[after\] = "1777559357"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: "1777556271"
          properties:
            before:
              type: string
              format: unix-time
              pattern: "^\\d{10}$"
              example: null
            between:
              type: string
              pattern: "^\\[\\d{10},\\d{10}\\]$"
              example: null
            "on":
              type: string
              format: unix-time
              pattern: "^\\d{10}$"
              example: null
            after:
              type: string
              format: unix-time
              pattern: "^\\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
      - name: omnichannel_subscription_item
        in: query
        description: |
          Parameters for omnichannel_subscription_item
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            status:
              type: object
              deprecated: false
              description: |
                Status of the `omnichannel_subscription_item`.
                [Learn more](omnichannel_statuses)
                about status and their mapping with the store's status.
              example: active
              properties:
                is:
                  type: string
                  description: |-
                    * `active` - active
                    * `expired` - expired
                    * `cancelled` - cancelled
                    * `in_dunning` - in_dunning
                    * `in_grace_period` - in_grace_period
                    * `paused` - paused
                  enum:
                  - active
                  - expired
                  - cancelled
                  - in_dunning
                  - in_grace_period
                  - paused
                  example: null
                is_not:
                  type: string
                  description: |-
                    * `active` - active
                    * `expired` - expired
                    * `cancelled` - cancelled
                    * `in_dunning` - in_dunning
                    * `in_grace_period` - in_grace_period
                    * `paused` - paused
                  enum:
                  - active
                  - expired
                  - cancelled
                  - in_dunning
                  - in_grace_period
                  - paused
                  example: null
                in:
                  type: string
                  description: |-
                    * `active` - active
                    * `expired` - expired
                    * `cancelled` - cancelled
                    * `in_dunning` - in_dunning
                    * `in_grace_period` - in_grace_period
                    * `paused` - paused
                  enum:
                  - active
                  - expired
                  - cancelled
                  - in_dunning
                  - in_grace_period
                  - paused
                  pattern: "^\\[(active|expired|cancelled|in_dunning|in_grace_period|paused)(,(active|expired|cancelled|in_dunning|in_grace_period|paused))*\\\
                    ]$"
                  example: null
                not_in:
                  type: string
                  description: |-
                    * `active` - active
                    * `expired` - expired
                    * `cancelled` - cancelled
                    * `in_dunning` - in_dunning
                    * `in_grace_period` - in_grace_period
                    * `paused` - paused
                  enum:
                  - active
                  - expired
                  - cancelled
                  - in_dunning
                  - in_grace_period
                  - paused
                  pattern: "^\\[(active|expired|cancelled|in_dunning|in_grace_period|paused)(,(active|expired|cancelled|in_dunning|in_grace_period|paused))*\\\
                    ]$"
                  example: null
            item_id_at_source:
              type: object
              deprecated: false
              description: |
                Product ID in the [`source`](omnichannel_subscriptions#omnichannel_subscription_source).
              example: gold
              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:
                        omnichannel_subscription:
                          $ref: "#/components/schemas/OmnichannelSubscription"
                          description: Resource object representing omnichannel_subscription
                      required:
                      - omnichannel_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: []
  /omnichannel_subscription_items/{omnichannel-subscription-item-id}/scheduled_changes:
    get:
      tags:
      - omnichannel_subscription_items
      summary: List scheduled changes for omnichannel subscription item
      description: |
        Returns scheduled changes for the specified `omnichannel_subscription_item`.

        Scheduled changes are created when the store will apply a product or pause change later (typically at term end), for example:

        * **Apple App Store** : Scheduled **downgrade** within the same subscription group.
        * **Google Play Store** : Product changes using the **`DEFERRED`** replacement mode. Immediate changes (`CHARGE_PRORATED_PRICE`) do **not** create a scheduled-change resource.

        Use this API when [`has_scheduled_changes`](/docs/api/omnichannel_subscription_items/omnichannel_subscription_item-object#has_scheduled_changes) is `true`. See also [`omnichannel_subscription_item_scheduled_change`](/docs/api/omnichannel_subscription_item_scheduled_changes) and [omnichannel events](/docs/api/omnichannel_events).
      operationId: list_scheduled_changes_for_omnichannel_subscription_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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: omnichannel-subscription-item-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/omnichannel-subscription-item-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        omnichannel_subscription_item_scheduled_change:
                          $ref: "#/components/schemas/OmnichannelSubscriptionItemScheduledChange"
                          description: Resource object representing omnichannel_subscription_item_scheduled_change
                      required:
                      - omnichannel_subscription_item_scheduled_change
                      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: []
  /recorded_purchases/{recorded-purchase-id}:
    get:
      tags:
      - recorded_purchases
      summary: Retrieve a recorded purchase
      description: |
        Retrieves a `recorded_purchase` object using the `recorded_purchase.id` returned by the [Record a Purchase API](/docs/api/recorded_purchases/record-a-purchase).

        Use this to poll job `status` and, when `completed`, obtain `omnichannel_transaction_id` plus either `linked_omnichannel_subscriptions` (subscription) or `linked_omnichannel_one_time_orders` (one-time order).
      operationId: retrieve_a_recorded_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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: recorded-purchase-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/recorded-purchase-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  recorded_purchase:
                    $ref: "#/components/schemas/RecordedPurchase"
                    description: |
                      Resource object representing Recorded purchase
                required:
                - recorded_purchase
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /recorded_purchases:
    post:
      tags:
      - recorded_purchases
      summary: Record a purchase
      description: |
        Records an in-app purchase from Apple App Store or Google Play Store in Chargebee. The API starts an asynchronous verification job and returns a `recorded_purchase` resource. Track progress with `status`: `in_process`, `completed`, `failed`, or `ignored`.

        Handle the **synchronous** API response first. The request can fail immediately (for example, an incorrect `app_id`, a malformed URL or request body, or a customer conflict on an already-recorded purchase) before any job is created---treat these as standard API errors (`4xx`). Only after the call is accepted and returns a `recorded_purchase` should you track the **asynchronous** job via `status` (`in_process` → `completed`, `failed`, or `ignored`). Omnichannel subscription or one-time order creation still happens asynchronously after a successful sync acceptance.

        ### Prerequisites

        * Configure the omnichannel app (`app_id`) for Apple or Google in Chargebee.
        * Provide exactly one store payload: `apple_app_store[...]` **or** `google_play_store[...]`.
        * Associate the purchase with a Chargebee `customer[id]` (created automatically if missing when customer details are supplied).

        ### Synchronous customer conflicts (existing purchase)

        If the store purchase is already recorded in Chargebee under a **different** customer, Record a Purchase returns a synchronous `4xx` (`customer_id_conflict_use_move_api` / `customer_id_mismatch`) and does **not** create a `recorded_purchase` job. To reassign ownership, use [Move an omnichannel subscription](/docs/api/omnichannel_subscriptions/move-an-omnichannel-subscription). Re-recording the same purchase for the **same** customer typically completes asynchronously with `status` `ignored` when the subscription or one-time order already exists.

        ### Apple App Store input (mutually exclusive paths)

        * Prefer `apple_app_store[transaction_id]` for subscriptions and one-time products when you have the StoreKit transaction ID.
        * Or pass `apple_app_store[receipt]` **and** `apple_app_store[product_id]`.

        ### Google Play Store input (mutually exclusive paths)

        * Prefer `google_play_store[order_id]` for subscriptions and one-time orders.
        * Or pass `google_play_store[purchase_token]` for subscriptions; for one-time orders also pass `google_play_store[product_id]`.

        ### Impacts (when `status` becomes `completed`)

        * **Subscription purchase** : Creates/links `linked_omnichannel_subscriptions`, sets `omnichannel_transaction_id`, and emits [`omnichannel_subscription_created`](/docs/api/events/webhook/omnichannel_subscription_created) (or [`omnichannel_subscription_imported`](/docs/api/events/webhook/omnichannel_subscription_imported) when historical transactions are present). Chargebee may also emit [`omnichannel_transaction_created`](/docs/api/events/webhook/omnichannel_transaction_created).
        * **One-time order purchase** : Creates/links `linked_omnichannel_one_time_orders`, sets `omnichannel_transaction_id`, and emits [`omnichannel_one_time_order_created`](/docs/api/events/webhook/omnichannel_one_time_order_created).

        ### Impacts (when `status` is `failed`)

        * Review [`error_detail`](/docs/api/recorded_purchases/recorded_purchase-object#error_detail) and correct the payload. Chargebee emits [`record_purchase_failed`](/docs/api/events/webhook/record_purchase_failed).

        ### Impacts (when `status` is `ignored`)

        * The purchase already has an omnichannel subscription or one-time order in Chargebee. No new linked resource is created for this job---use the existing resource. Linked IDs and `omnichannel_transaction_id` appear when `status` is `completed`, not for `ignored`.

        See [omnichannel events](/docs/api/omnichannel_events) for the full recording and notification mapping tables.
      operationId: record_a_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                app_id:
                  type: string
                  deprecated: false
                  description: |
                    App Identifier in Chargebee. This is the handle created by Chargebee for your app. To get the `app_id`:

                    * For **Apple** , follow [these steps](https://www.chargebee.com/docs/billing/2.0/mobile-subscriptions/omnichannel-app-store#create-an-omnichannel-subscription-for-in-app-purchases).
                    * For **Google** , follow [these steps](https://www.chargebee.com/docs/billing/2.0/mobile-subscriptions/omnichannel-play-store#connect-google-app-to-chargebee-to-generate-unique-app-id-and-notifications-url).
                  maxLength: 100
                  example: null
                customer:
                  type: object
                  deprecated: false
                  description: |
                    Customer parameters for associating (or creating) the Chargebee customer for this purchase.
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        The `id` of the [customer](/docs/api/customers/customer-object#id)
                        object associated with this purchase. The customer is created if one does not already exist.
                      maxLength: 50
                      example: null
                    email:
                      type: string
                      format: email
                      deprecated: false
                      description: |
                        Email of the customer. Used only when the customer is being created.
                      maxLength: 70
                      example: null
                    first_name:
                      type: string
                      deprecated: false
                      description: |
                        First name of the customer. Used only when the customer is being created.
                      maxLength: 150
                      example: null
                    last_name:
                      type: string
                      deprecated: false
                      description: |
                        Last name of the customer. Used only when the customer is being created.
                      maxLength: 150
                      example: null
                  required:
                  - id
                  example: null
                apple_app_store:
                  type: object
                  deprecated: false
                  description: |
                    Apple App Store--specific payload used to record the purchase. Provide parameters as `apple_app_store[...]`.

                    **Google Play Store**: Not applicable. Do not send this object for Google purchases.
                  properties:
                    transaction_id:
                      type: string
                      deprecated: false
                      description: |
                        **Apple App Store** : The StoreKit transaction identifier for the purchase to record (new subscription, expired re-purchase, or one-time product). Prefer this over `apple_app_store[receipt]` when you already have a transaction ID. Mutually exclusive with the receipt + product_id pair.

                        **Google Play Store**: Not applicable.
                      maxLength: 100
                      example: null
                    receipt:
                      type: string
                      deprecated: false
                      description: |
                        **Apple App Store** : The Base64-encoded App Store receipt used to locate and record the purchase. Use together with `apple_app_store[product_id]`. Mutually exclusive with `apple_app_store[transaction_id]` --- prefer `transaction_id` when you already have it.

                        **Google Play Store**: Not applicable.
                      maxLength: 65000
                      example: null
                    product_id:
                      type: string
                      deprecated: false
                      description: |
                        **Apple App Store** : The App Store Connect `product_id` for the purchase. Required when recording via `apple_app_store[receipt]` (use together with `receipt`). Not required when using `apple_app_store[transaction_id]`.

                        **Google Play Store**: Not applicable.
                      maxLength: 255
                      example: null
                  example: null
                google_play_store:
                  type: object
                  deprecated: false
                  description: |
                    Google Play Store--specific payload used to record the purchase. Provide parameters as `google_play_store[...]`.

                    **Apple App Store**: Not applicable. Do not send this object for Apple purchases.
                  properties:
                    purchase_token:
                      type: string
                      deprecated: false
                      description: |
                        **Google Play Store** : Purchase token from the Android billing client. For subscriptions, you can record tokens when the subscription state in Google is [`SUBSCRIPTION_STATE_ACTIVE`](https://developers.google.com/android-publisher/api-ref/rest/v3/purchases.subscriptionsv2#subscriptionstate)
                        (or other supported states for your flow). For one-time orders, also pass `google_play_store[product_id]`. Prefer `order_id` when you have it. Mutually exclusive with `google_play_store[order_id]`.

                        **Apple App Store**: Not applicable.
                      maxLength: 500
                      example: null
                    product_id:
                      type: string
                      deprecated: false
                      description: |
                        **Google Play Store** : In-app `product_id` on Google Play for which the purchase must be recorded. Required when recording a one-time order via `google_play_store[purchase_token]`. Not required when using `google_play_store[order_id]`.

                        **Apple App Store**: Not applicable.
                      maxLength: 255
                      example: null
                    order_id:
                      type: string
                      deprecated: false
                      description: |
                        **Google Play Store** : Google Play `orderId`. Recommended for both subscriptions and one-time orders. Prefer this over `purchase_token` when available. Mutually exclusive with `google_play_store[purchase_token]` (+ optional `product_id` for OTO).

                        **Apple App Store**: Not applicable.
                      maxLength: 100
                      example: null
                  example: null
                omnichannel_subscription:
                  type: object
                  deprecated: false
                  description: |
                    Optional parameters for the omnichannel subscription created from this purchase.
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Specifies the `id`
                        to assign as the omnichannel subscription identifier for this purchase. If not provided, Chargebee automatically generates an ID. Applicable to subscription purchases.
                      maxLength: 50
                      example: null
                  example: null
              required:
              - app_id
              example: null
            encoding:
              apple_app_store:
                style: deepObject
                explode: true
              customer:
                style: deepObject
                explode: true
              google_play_store:
                style: deepObject
                explode: true
              omnichannel_subscription:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  recorded_purchase:
                    $ref: "#/components/schemas/RecordedPurchase"
                    description: |
                      The `recorded_purchase` job object returned when the request is accepted synchronously. Includes `status` and linked resources when the async job completes. Synchronous API errors (for example, invalid `app_id` or a malformed request) occur before this object is returned.
                  customer:
                    $ref: "#/components/schemas/Customer"
                    description: |
                      Resource object representing customer
                required:
                - customer
                - recorded_purchase
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /omnichannel_one_time_orders:
    get:
      tags:
      - omnichannel_one_time_orders
      summary: List omnichannel one time orders
      description: |
        Returns a list of `omnichannel_one_time_order` objects. Filter by `customer_id` or `source` (`apple_app_store` / `google_play_store`).

        Use this together with [record a purchase](/docs/api/recorded_purchases/record-a-purchase) and webhook events such as `omnichannel_one_time_order_created` to reconcile one-time purchases.
      operationId: list_omnichannel_one_time_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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: source
        in: query
        description: |
          optional, enumerated string filter

          To filter based on OmnichannelOneTimeOrder Source. Possible values are : apple_app_store, google_play_store.

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

          **Example →**
          *source\[is_not\] = "apple_app_store"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: apple_app_store
          properties:
            is:
              type: string
              description: |-
                * `apple_app_store` - Source of the app is apple app store
                * `google_play_store` - Source of the app is google play store
              enum:
              - apple_app_store
              - google_play_store
              example: null
            is_not:
              type: string
              description: |-
                * `apple_app_store` - Source of the app is apple app store
                * `google_play_store` - Source of the app is google play store
              enum:
              - apple_app_store
              - google_play_store
              example: null
            in:
              type: string
              description: |-
                * `apple_app_store` - Source of the app is apple app store
                * `google_play_store` - Source of the app is google play store
              enum:
              - apple_app_store
              - google_play_store
              pattern: "^\\[(apple_app_store|google_play_store)(,(apple_app_store|google_play_store))*\\\
                ]$"
              example: null
            not_in:
              type: string
              description: |-
                * `apple_app_store` - Source of the app is apple app store
                * `google_play_store` - Source of the app is google play store
              enum:
              - apple_app_store
              - google_play_store
              pattern: "^\\[(apple_app_store|google_play_store)(,(apple_app_store|google_play_store))*\\\
                ]$"
              example: null
      - name: customer_id
        in: query
        description: |
          optional, string filter

          Chargebee Customer External Identifier.
          **Supported operators :**
          is, is_not, starts_with

          **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
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        omnichannel_one_time_order:
                          $ref: "#/components/schemas/OmnichannelOneTimeOrder"
                          description: Resource object representing omnichannel_one_time_order
                      required:
                      - omnichannel_one_time_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: []
  /omnichannel_one_time_orders/{omnichannel-one-time-order-id}:
    get:
      tags:
      - omnichannel_one_time_orders
      summary: Retrieve a one time order
      description: |
        Retrieves an `omnichannel_one_time_order` by its Chargebee `id`.

        You can obtain the ID from:

        * A successful [record a purchase](/docs/api/recorded_purchases/record-a-purchase) response (`linked_omnichannel_one_time_orders`)
        * The [list omnichannel one-time orders](/docs/api/omnichannel_one_time_orders/list-omnichannel-one-time-orders) API
        * Omnichannel webhook events such as `omnichannel_one_time_order_created`
      operationId: retrieve_an_omnichannel_one_time_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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: omnichannel-one-time-order-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/omnichannel-one-time-order-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  omnichannel_one_time_order:
                    $ref: "#/components/schemas/OmnichannelOneTimeOrder"
                    description: |
                      Resource object representing omnichannel_one_time_order
                required:
                - omnichannel_one_time_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: []
  /rules/{rule-id}:
    get:
      tags:
      - rules
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - 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: []
  /meters:
    get:
      tags:
      - meters
      summary: List all available meters
      description: |
        Retrieves the list of meters configured for the site.
      operationId: list_all_available_meters
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: name
        in: query
        description: |
          optional, string filter

          Filter meters based on `name`.

          **Supported operators :**
          is, starts_with

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

          Sorts based on the specified attribute.

          **Supported attributes :**
          id, name, created_at, updated_at

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

          **Example →**
          *sort_by\[desc\] = "updated_at"*

          This sorts the result based on the `updated_at` attribute in descending order (most recently updated first).
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
          properties:
            asc:
              type: string
              enum:
              - id
              - name
              - created_at
              - updated_at
              example: null
            desc:
              type: string
              enum:
              - id
              - name
              - 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:
                        meter:
                          $ref: "#/components/schemas/Meter"
                          description: Resource object representing meter
                      required:
                      - meter
                      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: []
  /usage_events:
    post:
      tags:
      - usage_events
      summary: Ingest a usage event
      description: "This endpoint ingests a usage event into Chargebee.  \n**See also**\n\
        \n* [Limits for Usage-based Billing in Chargebee](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/understanding-usages#usage-based-billing-limits)\n"
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                deduplication_id:
                  type: string
                  deprecated: false
                  description: |
                    An identifier used by the Chargebee's customer to distinguish between multiple events generated at the same timestamp for a single `subscription_id`.

                    The combination of `usage_timestamp`, `subscription_id`, and `deduplication_id` uniquely identifies each event.

                    **Example** :
                    If 3 events are generated for `subscription_id` = `sub-1` at `2025-04-01T00:00:00.000Z`, each event must have a distinct `deduplication_id`.
                  maxLength: 36
                  example: null
                subscription_id:
                  type: string
                  deprecated: false
                  description: "The unique identifier of a subscription.  \n**Note:**\n\
                    \n* If an existing `subscription_id` is provided, usage data is\
                    \ recorded against it.\n* If the subscription does not exist yet\
                    \ in Chargebee, a new `subscription_id` can be used, and the subscription\
                    \ can be imported later, once the usage is successfully recorded.\n\
                    * During invoice generation, recorded usage linked to the `subscription_id`\
                    \ will be applied to the invoice.\n"
                  maxLength: 50
                  example: null
                usage_timestamp:
                  type: integer
                  format: int64
                  deprecated: false
                  description: "The timestamp indicating when this usage occurred,\
                    \ represented as [Epoch](https://en.wikipedia.org/wiki/Unix_time)\n\
                    time in **milliseconds**\n.\nExample: `1738732394123`\nrepresents\
                    \ the timestamp for February 5, 2025, at 05:13:14.123 UTC.  \n\
                    **Note** :\nThe timestamp must be within the last **12 hours**\n\
                    .\n"
                  example: null
                properties:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: |
                    A schema-less field that accepts any JSON-formatted data to define the attributes of the ingested event. It is a requirement to structure the data in a flat format wherever possible for better compatibility with downstream processing.
                    We strongly encourage using unique field names-particularly for fields intended for metering purposes. This approach enhances clarity and maintainability in the future.
                    For example, a field named `status`,

                    * Can represent `string` values such as `accepted` or `processing` in one context.

                    * In another scenario, it might hold numeric values, such as HTTP response codes like `200`, `300`, or `400`.

                    **Note**:

                    * Learn more about [field naming guidelines](/docs/api/usage_files).
                  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: |
                      Resource object representing usage_event
                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:
      tags:
      - batch
      summary: Ingest usage events in batch
      description: "This endpoint ingests a batch of usage events into Chargebee.\
        \  \n**Note**\n: - You can ingest **500** events in a batch ingestion.  \n\
        **See also**\n\n* [Limits for Usage-based Billing in Chargebee](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/understanding-usages#usage-based-billing-limits)\n"
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                events:
                  type: object
                  deprecated: false
                  description: |
                    Parameters for batch usage events
                  properties:
                    deduplication_id:
                      type: array
                      description: |
                        An identifier used by the Chargebee's customer to distinguish between multiple events generated at the same timestamp for a single `subscription_id`.

                        The combination of `usage_timestamp`, `subscription_id`, and `deduplication_id` uniquely identifies each event.

                        **Example** :
                        If 3 events are generated for `subscription_id` = `sub-1` at `2025-04-01T00:00:00.000Z`, each event must have a distinct `deduplication_id`.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 36
                        example: null
                      example: null
                    subscription_id:
                      type: array
                      description: "The unique identifier of a subscription.  \n**Note:**\n\
                        \n* If an existing `subscription_id` is provided, usage data\
                        \ is recorded against it.\n* If the subscription does not\
                        \ exist yet in Chargebee, a new `subscription_id` can be used,\
                        \ and the subscription can be imported later, once the usage\
                        \ is successfully recorded.\n* During invoice generation,\
                        \ recorded usage linked to the `subscription_id` will be applied\
                        \ to the invoice.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                    usage_timestamp:
                      type: array
                      description: "The timestamp indicating when this usage occurred,\
                        \ represented as [Epoch](https://en.wikipedia.org/wiki/Unix_time)\n\
                        time in **milliseconds**\n.\nExample: `1738732394123`\nrepresents\
                        \ the timestamp for February 5, 2025, at 05:13:14.123 UTC.\
                        \  \n**Note** :\nThe timestamp must be within the last **12\
                        \ hours**\n.\n"
                      items:
                        type: integer
                        format: int64
                        deprecated: false
                        example: null
                      example: null
                    properties:
                      type: array
                      description: |
                        A schema-less field that accepts any JSON-formatted data to define the attributes of the ingested event. It is a requirement to structure the data in a flat format wherever possible for better compatibility with downstream processing.
                        We strongly encourage using unique field names-particularly for fields intended for metering purposes. This approach enhances clarity and maintainability in the future.
                        For example, a field named `status`,

                        * Can represent `string` values such as `accepted` or `processing` in one context.

                        * In another scenario, it might hold numeric values, such as HTTP response codes like `200`, `300`, or `400`.

                        **Note**:

                        * Learn more about [field naming guidelines](/docs/api/usage_files).
                      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
                    description: |
                      The unique identifier for the batch of usage events processed.
                    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"
  /metered_features/{metered-feature-id}/reactivate_command:
    post:
      tags:
      - metered_features
      summary: Reactivate a metered feature
      description: "Restores a previously archived metered feature `status` back to\
        \ `active`.  \n\n### Prerequisites \\& Constraints\n\n* The metered feature\
        \ `status` must be `archived`.  \n\n### Impacts\n\n**Metered feature**  \n\
        * The metered feature `status` is changed to `active`.\n* The meter `status`\
        \ is changed to `active`.  \n**Entitlements and subscription entitlements**\
        \  \n* New [entitlements](/docs/api/entitlements) and [subscription entitlements](/docs/api/subscription_entitlements)\
        \ can be created for the feature when it's reactivated.\n"
      operationId: reactivate_a_metered_feature
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: metered-feature-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/metered-feature-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  meter:
                    $ref: "#/components/schemas/Meter"
                    description: |
                      Resource object representing the meter for the metered feature.
                required:
                - meter
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /metered_features/{metered-feature-id}/delete:
    post:
      tags:
      - metered_features
      summary: Delete a metered feature
      description: "Permanently deletes a metered feature.  \n\n### Prerequisites\
        \ \\& Constraints\n\n* The metered feature `status` must not be `active`.\
        \  \n\n### Impacts\n\n**Entitlements and subscription entitlements**  \nAny\
        \ [entitlements](/docs/api/entitlements) and [subscription entitlements](/docs/api/subscription_entitlements)\
        \ defined for the feature are removed.\n"
      operationId: delete_a_metered_feature
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: metered-feature-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/metered-feature-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  meter:
                    $ref: "#/components/schemas/Meter"
                    description: |
                      Resource object representing the meter for the metered feature.
                required:
                - meter
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /metered_features:
    post:
      tags:
      - metered_features
      summary: Create a metered feature
      description: |
        Creates a metered feature.
      operationId: create_a_metered_feature
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                name:
                  type: string
                  deprecated: false
                  description: |
                    A case-sensitive name for the metered feature. For example: `API Calls`, `Input Tokens`.
                  maxLength: 50
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    A brief description of the metered feature.
                  maxLength: 250
                  example: null
                feature_unit:
                  type: string
                  deprecated: false
                  description: |
                    Unit of measure for the metered feature, in singular form. It is pluralized automatically as needed. For example, `request` or `token`.
                  maxLength: 50
                  example: null
                query:
                  type: string
                  deprecated: false
                  description: "The SQL query used to measure usage from [`usage_event`](/docs/api/usage_events)\
                    \ properties. For example: `SELECT SUM(api_calls) FROM events`.\
                    \  \n**Constraint**:\n\n* The properties referenced in the query\
                    \ must be one of `column_definitions.column_name`.\n"
                  maxLength: 1000
                  example: null
                column_definitions:
                  type: object
                  deprecated: false
                  description: |
                    Definitions of the columns or properties referenced by the `query`.
                  properties:
                    column_name:
                      type: array
                      description: "Name of the column or property used in the `query`.\
                        \  \n**Constraint**:\n\n* Must be one of the [`properties`](/docs/api/usage_events#properties)\
                        \ of a [`usage_event`](/docs/api/usage_events) object in Chargebee.\n"
                      items:
                        type: string
                        deprecated: false
                        maxLength: 100
                        example: null
                      example: null
                    data_type:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          Data type of the column or property.

                          * number - The column or property holds a numeric value.
                          * string - The column or property holds a string value.
                        enum:
                        - number
                        - string
                        example: null
                      example: null
                  required:
                  - column_name
                  - data_type
                  example: null
              required:
              - feature_unit
              - name
              - query
              example: null
            encoding:
              column_definitions:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  meter:
                    $ref: "#/components/schemas/Meter"
                    description: |
                      Resource object representing the meter for the metered feature.
                required:
                - meter
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /metered_features/{metered-feature-id}/archive_command:
    post:
      tags:
      - metered_features
      summary: Archive a metered feature
      description: "Archives a metered [feature](/docs/api/metered_features) and its\
        \ associated [meter](/docs/api/meters).  \n\n### Prerequisites \\& Constraints\n\
        \n* The metered feature must be `active`.  \n\n### Impacts\n\n**Entitlements\
        \ and subscription entitlements**  \n* New entitlements and subscription entitlements\
        \ cannot be created for the feature when it's archived.\n* Pre-existing entitlements\
        \ and subscription entitlements remain effective.  \n**Feature and meter**\
        \  \n* The feature and meter `status` are changed to `archived`.\n"
      operationId: archive_a_metered_feature
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: metered-feature-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/metered-feature-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  meter:
                    $ref: "#/components/schemas/Meter"
                    description: |
                      Resource object representing the meter for the metered feature.
                required:
                - meter
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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_files/{usage-file-id}/processing_status:
    get:
      tags:
      - usage_files
      summary: Retrieve file processing status
      description: |
        Use this endpoint to get the current status and details of a usage events file.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - 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: |
                      Resource object representing usage_file
                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:
      tags:
      - usage_files
      summary: Retrieve usage file upload URL
      description: "This endpoint returns an upload URL for uploading usage events\
        \ files, allowing you to upload files in supported formats. The file is processed\
        \ asynchronously, and its status can be tracked using the [retrieve_file_processing_status](/docs/api/usage_files/get-uploaded-file-processing-status)\
        \ endpoint.  \nBefore uploading, review the following guidelines and constraints:\n\
        \n* [Best practices](/docs/api/usage_files)\n* [File upload constraints](/docs/api/usage_files#file_upload_constraints)\n\
        * [File field constraints](/docs/api/usage_files)\n* [Handling errors](/docs/api/usage_files)\n"
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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.  \n**Note:**\nNo\
                    \ special characters are allowed in the `file_name`\nexcept for\
                    \ underscores `_`\nand hyphens `-`\n.**Example**:  \n\n|---------------------------|---------------------------|\n\
                    | **Valid file name**       | **Invalid file name**     |\n| merchant_data.csv\
                    \         | merchant@data.csv         |\n| sales_report-2024.csv\
                    \     | sales\\&report-2024.csv    |\n| customer_details_file.csv\
                    \ | customer!details#file.csv |\n\n"
                  maxLength: 150
                  example: null
                mime_type:
                  type: string
                  deprecated: false
                  description: "Indicates the format of a file.  \n**Note:**\nCurrently,\
                    \ only `text/csv`\nis supported.\n"
                  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: |
                      Resource object representing usage_file
                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"
  /einvoices:
    get:
      tags:
      - einvoices
      summary: List e-invoices
      description: |
        Returns a list of e-invoices. You can filter by id, reference id, updated at, invoice id, or credit note id.
      operationId: list_e-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: id
        in: query
        description: |
          optional, string filter

          The unique id for the e-invoice.
          **Supported operators :**
          is, in

          **Example →**
          *id\[is\] = "HmaT0avT2mtbTL3mR"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: HmaT0avT2mtbTL3mR
          properties:
            in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
            is:
              type: string
              minLength: 1
              example: null
      - name: reference_id
        in: query
        description: |
          optional, string filter

          Identifier returned by the connected e-invoicing provider for this submission.
          **Supported operators :**
          is, in

          **Example →**
          *reference_id\[is\] = "einvoice_ref_123"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: einvoice_ref_123
          properties:
            in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
            is:
              type: string
              minLength: 1
              example: null
      - name: updated_at
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          Filter e-invoices based on `updated_at`. Useful for downstream delta sync.
          It is advisable when using this filter, to pass the `sort_by`
          input parameter as `updated_at`
          for a faster response.
          **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 :**
          updated_at

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

          **Example →**
          *sort_by\[desc\] = "updated_at"*

          This will sort the result based on the 'updated_at' attribute in descending (latest first) order.
          When omitted, the list defaults to `updated_at` descending (with `id` as tiebreaker).
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
          properties:
            asc:
              type: string
              enum:
              - updated_at
              example: null
            desc:
              type: string
              enum:
              - updated_at
              example: null
          example: null
      - name: invoice_id
        in: query
        description: "Filter e-invoices belonging to the invoice with this id.  \n\
          **Constraints**\n\n* Query parameter (`invoice_id={invoice_id}`), not an\
          \ operator filter (`invoice_id[is]`).\n* Cannot be sent together with `credit_note_id`;\
          \ the API returns an error if both are passed.\n"
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          deprecated: false
          maxLength: 50
          example: null
      - name: credit_note_id
        in: query
        description: "Filter e-invoices belonging to the credit note with this id.\
          \  \n**Constraints**\n\n* Query parameter (`credit_note_id={credit_note_id}`),\
          \ not an operator filter (`credit_note_id[is]`).\n* Cannot be sent together\
          \ with `invoice_id`; the API returns an error if both are passed.\n"
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          deprecated: false
          maxLength: 50
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        einvoice:
                          $ref: "#/components/schemas/Einvoice"
                          description: Resource object representing einvoice
                      required:
                      - einvoice
                      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: []
  /einvoices/{einvoice-id}:
    get:
      tags:
      - einvoices
      summary: Retrieve an e-invoice
      description: |
        Retrieve the e-invoice for the specified e-invoice id (`einvoice_id`).
      operationId: retrieve_an_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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: einvoice-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/einvoice-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  einvoice:
                    $ref: "#/components/schemas/Einvoice"
                    description: |
                      Resource object representing einvoice
                required:
                - einvoice
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /personalized_offers:
    post:
      tags:
      - personalized_offers
      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.

        **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. 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.
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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.  \n**Note**\n\nThis parameter\
                    \ is ignored if it is 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).\n"
                  maxLength: 150
                  example: null
                last_name:
                  type: string
                  deprecated: false
                  description: "Last name of the customer.  \n**Note**\n\nThis parameter\
                    \ is ignored if it is 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).\n"
                  maxLength: 150
                  example: null
                email:
                  type: string
                  format: email
                  deprecated: false
                  description: "Customer's email address.  \n**Note**\n\nThis parameter\
                    \ is ignored if it is 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).\n"
                  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.).  \n**Note**\n\nThis parameter is ignored if it is 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).\n"
                  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 your system.\
                    \ This is used to identify the user for whom the offer is being\
                    \ created.  \n**Note**\n\nThis parameter is ignored if it is 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).\n"
                  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.  \n**Note**\n\nThis parameter\
                    \ is ignored if it is 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).\n"
                  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: |
                      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.
                    items:
                      $ref: "#/components/schemas/PersonalizedOffer"
                      description: Resource object representing personalized_offer
                    example: null
                  brand:
                    $ref: "#/components/schemas/Brand"
                    description: |
                      Resource object representing brand
                  expires_at:
                    type: integer
                    format: unix-time
                    deprecated: false
                    description: |
                      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.
                    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:
      tags:
      - offer_fulfillments
      summary: Create an offer fulfillment
      description: |
        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'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 `processing_type`:

        * `billing_update`: Initiates subscription or billing record updates (e.g., applying a discount or changing a plan) asynchronously.
        * `checkout`: Returns a `hosted_page` object in the response, which contains a URL to render the hosted checkout flow.
        * `url_redirect`: 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.
        * `webhook`: 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.
        * `email`: 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 `billing_update` and `checkout flows`. Upon actual fulfillment completion, the system logs a `fulfilled` event and sends notifications (webhook, Slack, email, Segment) as configured.
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      Represents the fulfillment created for the offer.
                  hosted_page:
                    $ref: "#/components/schemas/HostedPage"
                    description: |
                      Represents the hosted page created for the offer. This is returned only if the selected offer option's `processing_type`
                      is checkout.
                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:
      tags:
      - offer_fulfillments
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  offer_fulfillment:
                    $ref: "#/components/schemas/OfferFulfillment"
                    description: |
                      Represents the fulfillment created for the offer.
                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:
      tags:
      - offer_fulfillments
      summary: Update an offer fulfillment
      description: |
        This API is used to update the status of offer fulfillment for the processing types `url_redirect`, `webhook` and `email` as Chargebee cannot automatically fulfill these offers.

        If `status = failed`, you must include a `failure_reason` to explain why the fulfillment did not succeed. The system logs a `fulfilled` event when `status = completed` or a `failed` event when `status = failed`.

        **Note** : 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 `external_fulfillment_failed`.
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                    Explanation for failure; required when `status`
                    = `failed`
                    .
                  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: |
                      Represents the fulfillment created for the offer.
                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:
      tags:
      - offer_events
      summary: Create an offer event
      description: |
        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:

        * `viewed` - when an offer is displayed to the user.
        * `dismissed` - 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.

        **Note:** System-driven events like accepted and fulfilled are captured automatically by the growth system through fulfillment workflows. You do not need to post these.
      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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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:
      tags:
      - webhook_endpoints
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      The `webhook_endpoint`
                      resource object that contains the configuration and details of the created webhook.
                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:
      tags:
      - webhook_endpoints
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: |
                      The `webhook_endpoint`
                      resource object that contains the configuration and details of the created webhook.
                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:
      tags:
      - webhook_endpoints
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: "The target URL where webhook notifications will be\
                    \ sent.  \n**Note**\nOnly URL ports `80`, `443`, `8080`, or `8443`\
                    \ are allowed.\n"
                  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: |
                    Indicates whether the webhook endpoint is disabled. Set to `true`
                    to disable the endpoint, set to `false`
                    to enable the endpoint.
                  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/webhook_endpoints) by default.\n"
                  items:
                    type: string
                    deprecated: false
                    enum:
                    - 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
                    - einvoice_created
                    - einvoice_updated
                    - payment_schedules_created
                    - payment_schedules_updated
                    - payment_schedule_scheme_created
                    - payment_schedule_scheme_deleted
                    - subscription_renewal_reminder
                    - add_usages_reminder
                    - payment_due_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
                    - item_family_created
                    - item_family_updated
                    - item_family_deleted
                    - item_created
                    - item_updated
                    - item_deleted
                    - item_price_created
                    - item_price_updated
                    - item_price_deleted
                    - attached_item_created
                    - attached_item_updated
                    - attached_item_deleted
                    - differential_price_created
                    - differential_price_updated
                    - differential_price_deleted
                    - feature_created
                    - feature_updated
                    - feature_deleted
                    - feature_activated
                    - feature_reactivated
                    - feature_archived
                    - item_entitlements_updated
                    - entitlement_overrides_updated
                    - entitlement_overrides_removed
                    - item_entitlements_removed
                    - entitlement_overrides_auto_removed
                    - subscription_entitlements_created
                    - subscription_entitlements_updated
                    - business_entity_created
                    - business_entity_updated
                    - business_entity_deleted
                    - customer_business_entity_changed
                    - subscription_business_entity_changed
                    - payment_source_business_entity_changed
                    - purchase_created
                    - voucher_created
                    - voucher_expired
                    - voucher_create_failed
                    - item_price_entitlements_updated
                    - item_price_entitlements_removed
                    - subscription_ramp_created
                    - subscription_ramp_deleted
                    - subscription_ramp_applied
                    - subscription_ramp_drafted
                    - subscription_ramp_updated
                    - price_variant_created
                    - price_variant_updated
                    - price_variant_deleted
                    - customer_entitlements_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
                    - omnichannel_subscription_moved_in
                    - omnichannel_transaction_created
                    - alert_status_changed
                    - omnichannel_subscription_item_updated
                    - omnichannel_subscription_item_recovered
                    - omnichannel_subscription_item_mrr_updated
                    - ledger_account_balance_updated
                    - grant_blocks_created
                    - grant_blocks_updated
                    - ledger_updated
                    - business_rule_created
                    - business_rule_updated
                    - business_rule_activated
                    - business_rule_deactivated
                    - business_rule_deleted
                    - business_rule_released
                    - vault_token_created
                    - vault_token_updated
                    - vault_token_deleted
                    - business_rules_applied
                    - business_ruleset_created
                    - business_ruleset_updated
                    - business_ruleset_activated
                    - business_ruleset_deactivated
                    - business_ruleset_deleted
                    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: |
                      The `webhook_endpoint`
                      resource object that contains the configuration and details of the created webhook.
                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:
      tags:
      - webhook_endpoints
      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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          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:
      tags:
      - webhook_endpoints
      summary: Create a webhook endpoint
      description: |
        Create a new webhook API 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
      - name: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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: "The target URL where webhook notifications will be\
                    \ sent.  \n**Note**\nOnly URL ports `80`, `443`, `8080`, or `8443`\
                    \ are allowed.\n"
                  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: |
                    Indicates whether the webhook endpoint is disabled. Set to `true`
                    to disable the endpoint, set to `false`
                    to enable the endpoint.
                  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: "Indicates the response schema used in the webhook\
                    \ payload, based on the product catalog version configured for\
                    \ the site.  \n**Note**\nThis field is only applicable if the\
                    \ site is in [`compat`](https://www.chargebee.com/docs/billing/1.0/product-catalog/product-catalog-coexistence-ui-changes)\
                    \ mode.\n\n* compat - 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.\n* plans_addons\
                    \ -\n  The webhook payload follows the [Product Catalog 1.0](https://www.chargebee.com/docs/billing/1.0/product-catalog/product-catalog)\n\
                    \  schema and uses the [Plans](/docs/api/v2/pcv-1/plans)\n  and\
                    \ [Addons](/docs/api/v2/pcv-1/addons)\n  model.\n* items -\n \
                    \ The webhook payload follows the [Product Catalog 2.0](https://www.chargebee.com/docs/billing/2.0/product-catalog/product-catalog)\n\
                    \  schema and uses the [Items API model](/docs/api/items)\n  .\n"
                  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/webhook_endpoints) by default.\n"
                  items:
                    type: string
                    deprecated: false
                    enum:
                    - 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
                    - einvoice_created
                    - einvoice_updated
                    - payment_schedules_created
                    - payment_schedules_updated
                    - payment_schedule_scheme_created
                    - payment_schedule_scheme_deleted
                    - subscription_renewal_reminder
                    - add_usages_reminder
                    - payment_due_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
                    - item_family_created
                    - item_family_updated
                    - item_family_deleted
                    - item_created
                    - item_updated
                    - item_deleted
                    - item_price_created
                    - item_price_updated
                    - item_price_deleted
                    - attached_item_created
                    - attached_item_updated
                    - attached_item_deleted
                    - differential_price_created
                    - differential_price_updated
                    - differential_price_deleted
                    - feature_created
                    - feature_updated
                    - feature_deleted
                    - feature_activated
                    - feature_reactivated
                    - feature_archived
                    - item_entitlements_updated
                    - entitlement_overrides_updated
                    - entitlement_overrides_removed
                    - item_entitlements_removed
                    - entitlement_overrides_auto_removed
                    - subscription_entitlements_created
                    - subscription_entitlements_updated
                    - business_entity_created
                    - business_entity_updated
                    - business_entity_deleted
                    - customer_business_entity_changed
                    - subscription_business_entity_changed
                    - payment_source_business_entity_changed
                    - purchase_created
                    - voucher_created
                    - voucher_expired
                    - voucher_create_failed
                    - item_price_entitlements_updated
                    - item_price_entitlements_removed
                    - subscription_ramp_created
                    - subscription_ramp_deleted
                    - subscription_ramp_applied
                    - subscription_ramp_drafted
                    - subscription_ramp_updated
                    - price_variant_created
                    - price_variant_updated
                    - price_variant_deleted
                    - customer_entitlements_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
                    - omnichannel_subscription_moved_in
                    - omnichannel_transaction_created
                    - alert_status_changed
                    - omnichannel_subscription_item_updated
                    - omnichannel_subscription_item_recovered
                    - omnichannel_subscription_item_mrr_updated
                    - ledger_account_balance_updated
                    - grant_blocks_created
                    - grant_blocks_updated
                    - ledger_updated
                    - business_rule_created
                    - business_rule_updated
                    - business_rule_activated
                    - business_rule_deactivated
                    - business_rule_deleted
                    - business_rule_released
                    - vault_token_created
                    - vault_token_updated
                    - vault_token_deleted
                    - business_rules_applied
                    - business_ruleset_created
                    - business_ruleset_updated
                    - business_ruleset_activated
                    - business_ruleset_deactivated
                    - business_ruleset_deleted
                    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: |
                      The `webhook_endpoint`
                      resource object that contains the configuration and details of the created webhook.
                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: []
  /business_rules/apply_rules:
    post:
      tags:
      - business_rules
      summary: Apply business rules
      description: "Evaluates business rules against a context that you supply. You\
        \ can evaluate a single rule using `rule_id`, every rule in a ruleset using\
        \ `ruleset_id`, or an ad hoc expression using `structured_expression`. Set\
        \ `evaluate` to `true` to return only the evaluation result without running\
        \ the actions configured on the rules.\n\nThese three parameters are independent\
        \ of one another rather than alternatives. Passing more than one evaluates\
        \ each of them in the same request and returns the results together, so a\
        \ request carrying both `rule_id` and `ruleset_id` evaluates that rule and\
        \ that ruleset.\n\nThe response returns one entry in `apply_rule.rules[]`\
        \ for each rule that was evaluated, carrying the `evaluation_result` of its\
        \ expression, the `actions` that the result triggered, and an `error_message`\
        \ when the rule could not be evaluated. The entry for an ad hoc `structured_expression`\
        \ carries only `evaluation_result`, because there is no stored rule to describe.\
        \  \n\n### Prerequisites \\& Constraints\n\n* Business rules must be enabled\
        \ for the site.\n* A rule referenced by `rule_id` must be released and `active`,\
        \ and a ruleset referenced by `ruleset_id` must be `active`.  \n\n### Use\
        \ Cases\n\nEvaluate a single rule  \nPass `rule_id` along with the `context`.\
        \ The latest released version of that rule is evaluated on its own.  \nEvaluate\
        \ a group of rules together  \nPass `ruleset_id` along with the `context`.\
        \ The rules in the ruleset are evaluated in their priority order, and the\
        \ ruleset `execute_mode` decides whether evaluation stops early and which\
        \ results are returned.  \nTest an expression before saving it  \nPass `structured_expression`\
        \ and the `context` you want to test it against, with `evaluate` set to `true`.\
        \ This evaluates the expression without creating a rule and without executing\
        \ any actions.\n"
      operationId: apply_business_rules
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                evaluate:
                  type: boolean
                  deprecated: false
                  description: |
                    When set to `true`, skips rule action execution and only performs rule evaluation. Useful for testing rule conditions without executing associated actions.
                  example: null
                rule_id:
                  type: string
                  deprecated: false
                  description: |
                    The [business rule](/docs/api/business_rules) to evaluate. Its latest released version is evaluated, and one entry is returned for it in `apply_rule.rules[]`.
                  example: null
                ruleset_id:
                  type: string
                  deprecated: false
                  description: |
                    The [business ruleset](/docs/api/business_rulesets) to evaluate. Every rule it contains is evaluated in its priority order, following the strategy configured in the ruleset `execute_mode`, which also decides whether evaluation stops early and which of the results are returned.
                  example: null
                skip_failed_rules:
                  type: boolean
                  deprecated: false
                  description: |
                    Skip failed rules and continue processing the rest of the ruleset. A rule that could not be evaluated is returned with `error_message` set. When `false`, the request fails as soon as a rule cannot be evaluated.

                    This applies only to the rules evaluated through `ruleset_id`. A rule evaluated through `rule_id` and an expression evaluated through `structured_expression` fail the request regardless of this value.
                  example: null
                structured_expression:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: "An expression to evaluate without storing it as a\
                    \ rule. Use it to try an expression while you are building it.\
                    \ See [Expressions](/docs/api/business_rules#expressions) for\
                    \ the node types and the operators each field type supports. \
                    \ \n**Impacts**\n\n* The entry returned for the expression in\
                    \ `apply_rule.rules[]` carries only `evaluation_result`. No actions\
                    \ run, because actions belong to a stored rule rather than to\
                    \ an ad-hoc expression.\n* An `operator` applied to a field of\
                    \ another type cannot be evaluated and fails the request. `skip_failed_rules`\
                    \ does not apply to this parameter.\n\n**Example →**\n`structured_expression\
                    \ = {\"type\":\"GROUP\",\"operation\":\"AND\",\"children\":[{\"\
                    type\":\"CONDITION\",\"field\":\"customer.language\",\"operator\"\
                    :\"CONTAINS\",\"value\":\"en\"},{\"type\":\"CONDITION\",\"field\"\
                    :\"quote.shipping_address_country\",\"operator\":\"ANY_OF\",\"\
                    values\":[\"IN\",\"US\"]}]}`\n"
                  example: null
                context:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: "The data that the rule expressions are evaluated against,\
                    \ passed as a JSON object. The `field` of each condition is resolved\
                    \ against this object. See [Context](/docs/api/business_rules#context)\
                    \ for the schema and the fields a condition can reference.  \n\
                    **Constraints**\n\n* Must carry a `type`, which selects the schema\
                    \ that the rest of the object is read as. `CPQ` is the only type\
                    \ available.  \n**Impacts**\n\n* A key that falls outside the\
                    \ schema is dropped as the context is read.\n* A condition that\
                    \ references a field the context does not carry, including a key\
                    \ dropped for falling outside the schema, evaluates to `false`.\
                    \ The rule holding it does not match, and no `error_message` is\
                    \ returned for it.\n\n**Example →**\n`context = {\"type\":\"CPQ\"\
                    ,\"customer\":{\"language\":\"en\"},\"quote\":{\"shipping_address_country\"\
                    :\"IN\"}}`\n"
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  apply_rule:
                    $ref: "#/components/schemas/ApplyRule"
                    description: |
                      The outcome of the evaluation. It echoes back the `context` you passed and carries one entry in `rules[]` for each rule that was evaluated.

                      Each entry in `rules[]` holds the following.

                      * `id` and `version`: the rule that was evaluated, and the released version that was used.
                      * `name` and `description`: carried over from the rule.
                      * `evaluation_result`: `true` when the rule expression matched the context, and `false` when it did not.
                      * `actions`: the actions produced when `evaluation_result` is `true`, each carrying its `type`, the `action_template_id` of the template it was built from, and that template's parameters in `input`. It is absent for a rule that did not match. See [Actions](/docs/api/business_rules#actions) for what each template returns.
                      * `error_message`: the reason a rule could not be evaluated, such as an operator used on a field of another type. It is returned when `skip_failed_rules` is `true`.

                      When you pass `ruleset_id`, which of the evaluated rules appear in `rules[]` depends on the `execute_mode` of the [ruleset](/docs/api/business_rulesets). See [Evaluation results](/docs/api/business_rules#evaluation-results) for an annotated response, and [Context](/docs/api/business_rules#context) for the fields the echoed context can carry.
                required:
                - apply_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: []
  /business_rules/{business-rule-id}/delete_draft:
    post:
      tags:
      - business_rules
      summary: Delete a business rule draft
      description: "Deletes the draft version of a business rule, permanently discarding\
        \ every change that has not been released. The released version of the rule\
        \ is not affected.\n\nUse this operation to abandon a revision you no longer\
        \ want to release, and to leave the rule serving its released version unchanged.\
        \  \n\n### Prerequisites \\& Constraints\n\n* The rule must have a draft,\
        \ created by [Update a business rule draft](/docs/api/business_rules/update-a-business-rule-draft).\
        \  \n\n### Impacts\n\n**Business rule**  \nThe unreleased changes are discarded\
        \ and the rule no longer has a draft. `latest_version`, `released_at`, `released_by`,\
        \ and `active` are unchanged, and Chargebee keeps evaluating the released\
        \ version.\n\nThe next call to [Update a business rule draft](/docs/api/business_rules/update-a-business-rule-draft)\
        \ starts a fresh draft from the released version.  \n\n### Implementation\
        \ Notes\n\nReview the draft with [Retrieve a business rule draft](/docs/api/business_rules/retrieve-a-business-rule-draft)\
        \ before calling this operation, because the unreleased changes cannot be\
        \ recovered afterwards.\n"
      operationId: delete_a_business_rule_draft
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: business-rule-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/business-rule-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  business_rule:
                    $ref: "#/components/schemas/BusinessRule"
                    description: |
                      The newly created business rule, with its first version released so `latest_version` is `1`, and with `active` set to `false`.
                required:
                - business_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: []
  /business_rules/{business-rule-id}/release:
    post:
      tags:
      - business_rules
      summary: Release a business rule
      description: "Releases the draft version of a business rule. The draft is promoted\
        \ to the next version number and becomes the released version that Chargebee\
        \ evaluates, so `latest_version` is incremented and `released_at` is set.\
        \ Until you release it, the previously released version stays in effect.\n\
        \nUse this operation to promote a revision you staged with [Update a business\
        \ rule draft](/docs/api/business_rules/update-a-business-rule-draft).  \n\n\
        ### Prerequisites \\& Constraints\n\nThe rule must have a draft, created by\
        \ [Update a business rule draft](/docs/api/business_rules/update-a-business-rule-draft).\
        \  \n\n### Impacts\n\n**Business rule**  \nThe draft becomes the released\
        \ version of the rule, `latest_version` is incremented, and `released_at`\
        \ and `released_by` are set. The rule no longer has a draft, and Chargebee\
        \ starts evaluating the newly released version in place of the previous one.\
        \ Releasing does not change `active`, so a rule that has not been activated\
        \ is still not evaluated.\n\nEvery release is a new version, and each [business\
        \ ruleset](/docs/api/business_rulesets) that contains the rule picks up the\
        \ newly released version, because a ruleset always evaluates the latest released\
        \ version of its member rules.  \n\n### Implementation Notes\n\nReview the\
        \ version you are about to publish with [Retrieve a business rule draft](/docs/api/business_rules/retrieve-a-business-rule-draft)\
        \ before calling this operation, because releasing cannot be undone and the\
        \ change takes effect immediately for every ruleset that contains the rule.\n"
      operationId: release_a_business_rule
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: business-rule-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/business-rule-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  business_rule:
                    $ref: "#/components/schemas/BusinessRule"
                    description: |
                      The newly created business rule, with its first version released so `latest_version` is `1`, and with `active` set to `false`.
                required:
                - business_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: []
  /business_rules/{business-rule-id}/activate:
    post:
      tags:
      - business_rules
      summary: Activate a business rule
      description: "Activates a business rule by setting its `active` attribute to\
        \ `true`, so that Chargebee evaluates it.\n\nEvery rule is created inactive,\
        \ so this is the operation that puts a new rule into effect.  \n\n### Impacts\n\
        \n**Business rule**  \nThe rule `active` attribute is set to `true`. Chargebee\
        \ evaluates the version in `latest_version`, both when the rule is applied\
        \ directly and when it is reached through a [business ruleset](/docs/api/business_rulesets)\
        \ that contains it.\n\nNothing is released. If the rule has a draft, that\
        \ draft stays unreleased and the version in `latest_version` remains the one\
        \ evaluated.\n"
      operationId: activate_a_business_rule
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: business-rule-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/business-rule-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  business_rule:
                    $ref: "#/components/schemas/BusinessRule"
                    description: |
                      The newly created business rule, with its first version released so `latest_version` is `1`, and with `active` set to `false`.
                required:
                - business_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: []
  /business_rules/{business-rule-id}/draft:
    get:
      tags:
      - business_rules
      summary: Retrieve a business rule draft
      description: "Retrieves the draft version of a business rule. The draft holds\
        \ changes that have not been released yet, so it can differ from the released\
        \ version returned by [Retrieve a business rule](/docs/api/business_rules/retrieve-a-business-rule).\n\
        \nUse this operation to review a staged change before releasing it.  \n\n\
        ### Prerequisites \\& Constraints\n\n* The rule must have a draft. A rule\
        \ has one only after [Update a business rule draft](/docs/api/business_rules/update-a-business-rule-draft)\
        \ creates it, so a rule that has never been edited, or whose draft has been\
        \ released or deleted, has no draft to return.\n"
      operationId: retrieve_a_business_rule_draft
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: business-rule-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/business-rule-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  business_rule:
                    $ref: "#/components/schemas/BusinessRule"
                    description: |
                      The newly created business rule, with its first version released so `latest_version` is `1`, and with `active` set to `false`.
                required:
                - business_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: []
    post:
      tags:
      - business_rules
      summary: Update a business rule draft
      description: "Updates the draft version of a business rule. The first edit creates\
        \ a draft from the released version, and every later edit updates that same\
        \ draft. Changes made to a draft do not affect rule evaluation until the draft\
        \ is released.\n\nSend the full definition of the rule rather than only the\
        \ attributes you are changing. The values you pass replace the draft instead\
        \ of being merged into it, so an attribute you leave out is dropped from the\
        \ draft rather than carried over.\n\nUse this operation to revise a rule that\
        \ is already in use. The released version stays in effect while you prepare\
        \ the next one, which lets you stage a change and review it before it takes\
        \ effect.  \n\n### Prerequisites \\& Constraints\n\nBusiness rules must be\
        \ enabled for the site.  \n\n### Impacts\n\n**Business rule**  \nThe draft\
        \ version of the rule is replaced with the values you pass, and `updated_at`\
        \ and `updated_by` are set. `latest_version`, `released_at`, `released_by`,\
        \ and `active` are unchanged, and Chargebee keeps evaluating the released\
        \ version.  \n\n### Implementation Notes\n\n* Retrieve the current definition\
        \ before you send this request, so that you can pass it back in full. Use\
        \ [Retrieve a business rule draft](/docs/api/business_rules/retrieve-a-business-rule-draft)\
        \ if the rule already has a draft, or [Retrieve a business rule](/docs/api/business_rules/retrieve-a-business-rule)\
        \ if it does not, which returns the released version the draft will be created\
        \ from.\n* Call [Release a business rule](/docs/api/business_rules/release-a-business-rule)\
        \ to promote the draft to the version that Chargebee evaluates, or [Delete\
        \ a business rule draft](/docs/api/business_rules/delete-a-business-rule-draft)\
        \ to discard it.\n"
      operationId: update_a_business_rule_draft
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: business-rule-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/business-rule-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: |
                    Display name of the business rule.
                  maxLength: 500
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    Description of what the business rule does.
                  maxLength: 1000
                  example: null
                tags:
                  type: array
                  deprecated: false
                  items:
                    example: null
                  example: null
                structured_expression:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: "A structured JSON representation of the rule logic,\
                    \ designed for visual editors and dynamic builders. Chargebee\
                    \ validates and compiles it when the draft is updated. Pass it\
                    \ as a JSON object.\n\nSee [Expressions](/docs/api/business_rules#expressions)\
                    \ for the node types and the operators each field type supports,\
                    \ and [Context](/docs/api/business_rules#context) for the fields\
                    \ a condition can reference.  \n**Impacts**\n\n* A condition whose\
                    \ `field` is absent from the context passed to [Apply business\
                    \ rules](/docs/api/business_rules/apply-business-rules) evaluates\
                    \ to `false`, so the rule never matches and no error is returned.\n\
                    \n**Example →**\n`structured_expression = {\"type\":\"GROUP\"\
                    ,\"operation\":\"AND\",\"children\":[{\"type\":\"CONDITION\",\"\
                    field\":\"customer.language\",\"operator\":\"CONTAINS\",\"value\"\
                    :\"en\"},{\"type\":\"CONDITION\",\"field\":\"quote.shipping_address_country\"\
                    ,\"operator\":\"ANY_OF\",\"values\":[\"IN\",\"US\",\"GB\"]}]}`\n"
                  example: null
                actions_on_success:
                  type: array
                  deprecated: false
                  description: |
                    The actions to execute when the rule expression evaluates to `true`, passed as a JSON array. Each action takes the `action_template_id` of the template it is built from and that template's parameters in `input`.

                    See [Actions](/docs/api/business_rules#actions) for the templates available, the parameters each one takes, and the optional action-level `structured_expression` that narrows the items an action applies to.

                    **Example →**
                    `actions_on_success = [{"action_template_id":"action-apply-discount","input":{"apply_on":"invoice_amount","duration_type":"one_time","discount":15.0,"discount_type":"percentage"}}]`
                  items:
                    example: null
                  example: null
              required:
              - name
              - structured_expression
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  business_rule:
                    $ref: "#/components/schemas/BusinessRule"
                    description: |
                      The newly created business rule, with its first version released so `latest_version` is `1`, and with `active` set to `false`.
                required:
                - business_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: []
  /business_rules/{business-rule-id}/delete:
    post:
      tags:
      - business_rules
      summary: Delete a business rule
      description: "Deletes a business rule and removes it from every business ruleset\
        \ it belongs to. This is a soft delete: the rule is no longer returned by\
        \ the API or evaluated by Chargebee, but its `id` cannot be reused.  \n\n\
        ### Impacts\n\n**Business rule**  \nThe rule is deleted along with its versions,\
        \ and is no longer returned by [Retrieve a business rule](/docs/api/business_rules/retrieve-a-business-rule)\
        \ or [List business rules](/docs/api/business_rules/list-business-rules).\
        \  \n**Business rulesets**  \nThe rule is removed from every ruleset it belongs\
        \ to, and is no longer returned by [List rules in a business ruleset](/docs/api/business_rulesets/list-rules-in-a-business-ruleset)\
        \ for those rulesets. The rulesets themselves and their remaining rules are\
        \ not affected.  \n\n### Implementation Notes\n\n* Deletion cannot be undone.\
        \ If you only need to stop the rule being evaluated, use [Deactivate a business\
        \ rule](/docs/api/business_rules/deactivate-a-business-rule) instead, which\
        \ keeps the rule and its ruleset memberships intact.\n* Call [List rules in\
        \ a business ruleset](/docs/api/business_rulesets/list-rules-in-a-business-ruleset)\
        \ on the rulesets that contain the rule if you need to know which rules are\
        \ left in them after the deletion.\n"
      operationId: delete_a_business_rule
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: business-rule-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/business-rule-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  business_rule:
                    $ref: "#/components/schemas/BusinessRule"
                    description: |
                      The newly created business rule, with its first version released so `latest_version` is `1`, and with `active` set to `false`.
                required:
                - business_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: []
  /business_rules/{business-rule-id}/deactivate:
    post:
      tags:
      - business_rules
      summary: Deactivate a business rule
      description: "Deactivates a business rule by setting its `active` attribute\
        \ to `false`. The rule is retained along with its versions and ruleset memberships,\
        \ but Chargebee stops evaluating it.\n\nUse this operation to switch a rule\
        \ off temporarily. Because nothing is discarded, you can switch it back on\
        \ later with [Activate a business rule](/docs/api/business_rules/activate-a-business-rule).\
        \  \n\n### Impacts\n\n**Business rule**  \nThe rule `active` attribute is\
        \ set to `false`. Chargebee stops evaluating the rule, including when it is\
        \ reached through a [business ruleset](/docs/api/business_rulesets) that contains\
        \ it. The rule versions and ruleset memberships are retained.  \n\n### Implementation\
        \ Notes\n\nTo stop evaluating every rule in a ruleset at once, deactivate\
        \ the ruleset with [Deactivate a business ruleset](/docs/api/business_rulesets/deactivate-a-business-ruleset)\
        \ instead of deactivating its rules one by one.\n"
      operationId: deactivate_a_business_rule
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: business-rule-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/business-rule-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  business_rule:
                    $ref: "#/components/schemas/BusinessRule"
                    description: |
                      The newly created business rule, with its first version released so `latest_version` is `1`, and with `active` set to `false`.
                required:
                - business_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: []
  /business_rules/{business-rule-id}:
    get:
      tags:
      - business_rules
      summary: Retrieve a business rule
      description: |
        Retrieves the released version of the business rule with the specified `id`, which is the version Chargebee evaluates. The response describes the version in `latest_version`.

        If the rule has been edited since that version was released, those changes are held in its draft and are not part of this response. Use [Retrieve a business rule draft](/docs/api/business_rules/retrieve-a-business-rule-draft) to read them.
      operationId: retrieve_a_business_rule
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: business-rule-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/business-rule-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  business_rule:
                    $ref: "#/components/schemas/BusinessRule"
                    description: |
                      The newly created business rule, with its first version released so `latest_version` is `1`, and with `active` set to `false`.
                required:
                - business_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: []
  /business_rules:
    get:
      tags:
      - business_rules
      summary: List business rules
      description: |
        Returns a list of business rules satisfying all the conditions specified in the filter parameters.

        Each rule is returned as its released version. Deleted rules are not returned.
      operationId: list_business_rules
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: draft
        in: query
        description: |
          optional, boolean filter

          Filters the results by the draft state of the business rule. Pass `true` to return the rules that have an unreleased draft, and `false`, the default, to return the rules as of their released version.
          **Supported operators :**
          is

          **Example →**
          *draft\[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: active
        in: query
        description: |
          optional, boolean filter

          Filters the results by the active status of the business rule. Pass `true` to return only the rules Chargebee currently evaluates, and `false` to return only the rules that are switched off. When omitted, rules are returned irrespective of their active status.
          **Supported operators :**
          is

          **Example →**
          *active\[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
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        business_rule:
                          $ref: "#/components/schemas/BusinessRule"
                          description: Resource object representing business_rule
                      required:
                      - business_rule
                      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:
      tags:
      - business_rules
      summary: Create a business rule
      description: "Creates a business rule and releases its first version, so the\
        \ new rule has `latest_version` set to `1` and `released_at` set. The rule\
        \ is created inactive: Chargebee does not evaluate it until you call [Activate\
        \ a business rule](/docs/api/business_rules/activate-a-business-rule).\n\n\
        Use this operation to encode a decision that Chargebee should make repeatedly\
        \ and consistently, such as the discount to offer on a qualifying quote or\
        \ the constraint that a quote must satisfy before it is sent to a customer.\
        \ The condition goes in `structured_expression`, and what should happen when\
        \ the condition is met goes in `actions_on_success`.  \n\n### Prerequisites\
        \ \\& Constraints\n\nBusiness rules must be enabled for the site.  \n\n###\
        \ Impacts\n\n**Business rule**  \nA business rule is created with its first\
        \ version released, so `latest_version` is `1` and `released_at` and `released_by`\
        \ are set. The rule is created with `active` set to `false`, so Chargebee\
        \ does not evaluate it yet.  \n\n### Implementation Notes\n\n* Call [Activate\
        \ a business rule](/docs/api/business_rules/activate-a-business-rule) to put\
        \ the new rule into effect. [Release a business rule](/docs/api/business_rules/release-a-business-rule)\
        \ is only needed later, once you have edited the rule and want the resulting\
        \ draft to take effect.\n* To check an expression against sample data before\
        \ you store it as a rule, call [Apply business rules](/docs/api/business_rules/apply-business-rules)\
        \ with `structured_expression` and a `context`, and with `evaluate` set to\
        \ `true` so that no actions are executed.\n"
      operationId: create_a_business_rule
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                id:
                  type: string
                  deprecated: false
                  description: "Unique identifier for the business rule. If not provided,\
                    \ Chargebee generates one.  \n**Constraints**\n\n* The identifier\
                    \ of a deleted rule cannot be reused.\n"
                  maxLength: 100
                  example: null
                name:
                  type: string
                  deprecated: false
                  description: |
                    Display name of the business rule.
                  maxLength: 500
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    Description of what the business rule does.
                  maxLength: 1000
                  example: null
                tags:
                  type: array
                  deprecated: false
                  items:
                    example: null
                  example: null
                structured_expression:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: "A structured JSON representation of the rule logic,\
                    \ designed for visual editors and dynamic builders. Chargebee\
                    \ validates and compiles it when the rule is created. Pass it\
                    \ as a JSON object.\n\nSee [Expressions](/docs/api/business_rules#expressions)\
                    \ for the node types and the operators each field type supports,\
                    \ and [Context](/docs/api/business_rules#context) for the fields\
                    \ a condition can reference.  \n**Impacts**\n\n* A condition whose\
                    \ `field` is absent from the context passed to [Apply business\
                    \ rules](/docs/api/business_rules/apply-business-rules) evaluates\
                    \ to `false`, so the rule never matches and no error is returned.\n\
                    \n**Example →**\n`structured_expression = {\"type\":\"GROUP\"\
                    ,\"operation\":\"AND\",\"children\":[{\"type\":\"CONDITION\",\"\
                    field\":\"customer.language\",\"operator\":\"CONTAINS\",\"value\"\
                    :\"en\"},{\"type\":\"CONDITION\",\"field\":\"quote.shipping_address_country\"\
                    ,\"operator\":\"ANY_OF\",\"values\":[\"IN\",\"US\"]}]}`\n"
                  example: null
                actions_on_success:
                  type: array
                  deprecated: false
                  description: |
                    The actions to execute when the rule expression evaluates to `true`, passed as a JSON array. Each action takes the `action_template_id` of the template it is built from and that template's parameters in `input`.

                    See [Actions](/docs/api/business_rules#actions) for the templates available, the parameters each one takes, and the optional action-level `structured_expression` that narrows the items an action applies to.

                    **Example →**
                    `actions_on_success = [{"action_template_id":"action-apply-discount","input":{"apply_on":"invoice_amount","duration_type":"one_time","discount":12.0,"discount_type":"percentage"}}]`
                  items:
                    example: null
                  example: null
              required:
              - name
              - structured_expression
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  business_rule:
                    $ref: "#/components/schemas/BusinessRule"
                    description: |
                      The newly created business rule, with its first version released so `latest_version` is `1`, and with `active` set to `false`.
                required:
                - business_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: []
  /business_rulesets/{business-ruleset-id}:
    get:
      tags:
      - business_rulesets
      summary: Retrieve a business ruleset
      description: |
        Retrieves the business ruleset with the specified `id`. To fetch the rules it contains, use [List rules in a business ruleset](/docs/api/business_rulesets/list-rules-in-a-business-ruleset).
      operationId: retrieve_a_business_ruleset
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: business-ruleset-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/business-ruleset-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  business_ruleset:
                    $ref: "#/components/schemas/BusinessRuleset"
                    description: |
                      The business ruleset with the rules added to its membership. Its `name`, `description`, `execute_mode`, and `active` attributes are unchanged.
                required:
                - business_ruleset
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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:
      tags:
      - business_rulesets
      summary: Update a business ruleset
      description: "Updates a business ruleset. Passing `rules` replaces the entire\
        \ membership of the ruleset. To change membership incrementally, use [Add\
        \ business rules to a ruleset](/docs/api/business_rulesets/add-business-rules-to-a-ruleset)\
        \ or [Remove business rules from a ruleset](/docs/api/business_rulesets/remove-business-rules-from-a-ruleset)\
        \ instead.\n\nUse this operation to rename a ruleset, to change the strategy\
        \ in `execute_mode`, or to set the membership and priorities of the ruleset\
        \ in one call.  \n\n### Prerequisites \\& Constraints\n\nEach rule referenced\
        \ in `rules` must already exist.  \n\n### Impacts\n\n**Business ruleset**\
        \  \nThe attributes you pass are updated, and `updated_at` and `updated_by`\
        \ are set. When `rules` is passed, the membership of the ruleset becomes exactly\
        \ the rules listed: rules that are not in the list are removed from the ruleset,\
        \ and the priorities of the remaining rules are set from the list.\n\nA rule\
        \ dropped from the membership this way is not deleted. It remains available\
        \ to other rulesets and can still be applied on its own.  \n\n### Implementation\
        \ Notes\n\nRead the current membership with [List rules in a business ruleset](/docs/api/business_rulesets/list-rules-in-a-business-ruleset)\
        \ before passing `rules`, so that you do not drop a rule you meant to keep.\n"
      operationId: update_a_business_ruleset
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: business-ruleset-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/business-ruleset-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: |
                    Display name of the business ruleset. Include it even when you are only changing another attribute, such as `execute_mode`.
                  maxLength: 500
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    Description of what the business ruleset does.
                  maxLength: 1000
                  example: null
                execute_mode:
                  type: string
                  default: execute_all
                  deprecated: false
                  description: |
                    Strategy that determines how the rules in the ruleset are evaluated and when evaluation stops.

                    * execute_all - Every rule in the ruleset is evaluated and all the results are returned. This is the default.
                    * stop_on_first_true - Evaluation stops as soon as a rule evaluates to `true`. The rules that come later in the evaluation order are not evaluated.
                    * execute_all_true - Every rule in the ruleset is evaluated, and only the rules that evaluated to `true` are returned.
                    * stop_on_first_false - Evaluation stops as soon as a rule evaluates to `false`. The rules that come later in the evaluation order are not evaluated.
                  enum:
                  - stop_on_first_true
                  - stop_on_first_false
                  - execute_all
                  - execute_all_true
                  example: null
                rules:
                  type: array
                  deprecated: false
                  description: "The [business rules](/docs/api/business_rules) that\
                    \ make up the ruleset, along with the priorities that determine\
                    \ their positions in its evaluation order. Each entry takes the\
                    \ `rule_id` of an existing business rule and an optional `priority`;\
                    \ when `priority` is omitted, it is assigned from the position\
                    \ of the entry in the array. Pass the list as a JSON array.  \n\
                    **Constraints**\n\n* Passing this parameter replaces the entire\
                    \ membership of the ruleset. To change the membership incrementally,\
                    \ use [Add business rules to a ruleset](/docs/api/business_rulesets/add-business-rules-to-a-ruleset)\
                    \ or [Remove business rules from a ruleset](/docs/api/business_rulesets/remove-business-rules-from-a-ruleset)\
                    \ instead.\n* Each `rule_id` must belong to a business rule that\
                    \ already exists, and can appear only once in the list.\n* A `priority`\
                    \ can be used by only one rule in the ruleset. Two entries that\
                    \ carry the same `priority` are rejected.\n\n**Example →**\n`rules\
                    \ = [{\"rule_id\":\"custom-uuid-1\",\"priority\":1},{\"rule_id\"\
                    :\"custom-uuid-2\",\"priority\":2}]`\n"
                  items:
                    example: null
                  example: null
              required:
              - name
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  business_ruleset:
                    $ref: "#/components/schemas/BusinessRuleset"
                    description: |
                      The business ruleset with the rules added to its membership. Its `name`, `description`, `execute_mode`, and `active` attributes are unchanged.
                required:
                - business_ruleset
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /business_rulesets/{business-ruleset-id}/remove_rules:
    post:
      tags:
      - business_rulesets
      summary: Remove business rules from a ruleset
      description: "Removes one or more business rules from a ruleset without changing\
        \ any of its other attributes. The rules themselves are not deleted and remain\
        \ available to other rulesets.\n\nUse this operation to take a rule out of\
        \ a decision while keeping the rule itself, for example when it has been superseded\
        \ by another rule in the same ruleset.  \n\n### Impacts\n\n**Business ruleset**\
        \  \nThe rules are removed from the ruleset and are no longer evaluated when\
        \ the ruleset is applied, and `updated_at` and `updated_by` are set. The `name`,\
        \ `description`, `execute_mode`, and `active` attributes of the ruleset are\
        \ unchanged.  \n\n### Implementation Notes\n\n* The rules are not deleted.\
        \ They keep their versions and stay available to other rulesets and to [Apply\
        \ business rules](/docs/api/business_rules/apply-business-rules) with `rule_id`.\
        \ To delete a rule outright, use [Delete a business rule](/docs/api/business_rules/delete-a-business-rule).\n\
        * To keep a rule in the ruleset but stop evaluating it, use [Deactivate a\
        \ business rule](/docs/api/business_rules/deactivate-a-business-rule) instead.\n"
      operationId: remove_business_rules_from_a_ruleset
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: business-ruleset-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/business-ruleset-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
              properties:
                rules:
                  type: array
                  deprecated: false
                  description: |
                    The business rules to remove from the ruleset. Each entry takes the `rule_id` of a rule that currently belongs to the ruleset. Pass the list as a JSON array.

                    **Example →**
                    `rules = [{"rule_id":"custom-uuid-3"}]`
                  items:
                    example: null
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  business_ruleset:
                    $ref: "#/components/schemas/BusinessRuleset"
                    description: |
                      The business ruleset with the rules added to its membership. Its `name`, `description`, `execute_mode`, and `active` attributes are unchanged.
                required:
                - business_ruleset
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /business_rulesets/{business-ruleset-id}/delete:
    post:
      tags:
      - business_rulesets
      summary: Delete a business ruleset
      description: "Permanently deletes a business ruleset.  \n\n### Prerequisites\
        \ \\& Constraints\n\n* The business ruleset must not contain any business\
        \ rules. If it does, [remove the business rules from the ruleset](/docs/api/business_rulesets/remove-business-rules-from-a-ruleset)\
        \ before deleting it.  \n\n### Impacts\n\n**Business ruleset**  \nChargebee\
        \ permanently deletes the business ruleset. This operation can't be undone.\
        \ To stop evaluating a business ruleset without deleting it, use [Deactivate\
        \ a business ruleset](/docs/api/business_rulesets/deactivate-a-business-ruleset).\
        \  \n**Business rules**  \nDeleting a ruleset **does not** delete the business\
        \ rules associated with it. To delete the business rules, use [Delete a business\
        \ rule](/docs/api/business_rules/delete-a-business-rule).\n"
      operationId: delete_a_business_ruleset
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: business-ruleset-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/business-ruleset-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  business_ruleset:
                    $ref: "#/components/schemas/BusinessRuleset"
                    description: |
                      The business ruleset with the rules added to its membership. Its `name`, `description`, `execute_mode`, and `active` attributes are unchanged.
                required:
                - business_ruleset
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /business_rulesets/{business-ruleset-id}/deactivate:
    post:
      tags:
      - business_rulesets
      summary: Deactivate a business ruleset
      description: "Deactivates a business ruleset by setting its `active` attribute\
        \ to `false`. The ruleset and its rule memberships are retained, but Chargebee\
        \ stops evaluating it.\n\nUse this operation to switch off a whole group of\
        \ rules in one call, without changing the rules themselves.  \n\n### Impacts\n\
        \n**Business ruleset**  \nThe ruleset `active` attribute is set to `false`\
        \ and Chargebee stops evaluating it. The rules it contains and their priorities\
        \ are retained, and each rule keeps its own `active` value, so a rule that\
        \ belongs to another `active` ruleset is still evaluated there.  \n\n### Implementation\
        \ Notes\n\nThe rules in the ruleset are not deactivated. They can still be\
        \ applied on their own with [Apply business rules](/docs/api/business_rules/apply-business-rules)\
        \ using `rule_id`. To switch off an individual rule everywhere, use [Deactivate\
        \ a business rule](/docs/api/business_rules/deactivate-a-business-rule).\n"
      operationId: deactivate_a_business_ruleset
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: business-ruleset-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/business-ruleset-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  business_ruleset:
                    $ref: "#/components/schemas/BusinessRuleset"
                    description: |
                      The business ruleset with the rules added to its membership. Its `name`, `description`, `execute_mode`, and `active` attributes are unchanged.
                required:
                - business_ruleset
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /business_rulesets/{business-ruleset-id}/rules:
    get:
      tags:
      - business_rulesets
      summary: List rules in a business ruleset
      description: "Returns the business rules that belong to a ruleset, along with\
        \ the priority that determines their evaluation order. The results can be\
        \ filtered by active status and are paginated.\n\nEach entry carries the `rule_id`\
        \ of the rule and its `priority` within this ruleset. Use `rule_id` with [Retrieve\
        \ a business rule](/docs/api/business_rules/retrieve-a-business-rule) to read\
        \ the definition of a rule.  \n\n### Implementation Notes\n\n* Call this operation\
        \ before passing `rules` to [Update a business ruleset](/docs/api/business_rulesets/update-a-business-ruleset),\
        \ because that parameter replaces the entire membership of the ruleset.\n"
      operationId: list_rules_in_a_business_ruleset
      parameters:
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          deprecated: false
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          deprecated: false
          maxLength: 1000
          example: null
      - name: active
        in: query
        description: |
          optional, boolean filter

          Filters the results by the active status of the business rules in the ruleset. Pass `true` to return only the rules that are evaluated when the ruleset is applied, and `false` to return only the rules that are switched off. When omitted, rules are returned irrespective of their active status.
          **Supported operators :**
          is

          **Example →**
          *active\[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: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: business-ruleset-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/business-ruleset-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  business_ruleset_rule:
                    $ref: "#/components/schemas/BusinessRulesetRule"
                    description: |
                      The membership of one rule in the ruleset. It carries `rule_id`, the identifier of the [business rule](/docs/api/business_rules), and `priority`, the number that fixes the position of that rule in the ruleset's evaluation order. Priorities are unique within a ruleset.

                      The definition of the rule is not included. Use `rule_id` with [Retrieve a business rule](/docs/api/business_rules/retrieve-a-business-rule) to read its expression and actions.
                required:
                - business_ruleset_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: []
  /business_rulesets:
    get:
      tags:
      - business_rulesets
      summary: List business rulesets
      description: |
        Returns a list of business rulesets satisfying all the conditions specified in the filter parameters. The response describes each ruleset but does not carry its membership; use [List rules in a business ruleset](/docs/api/business_rulesets/list-rules-in-a-business-ruleset) to page through the rules of a particular ruleset.
      operationId: list_business_rulesets
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: active
        in: query
        description: |
          optional, boolean filter

          Filters the results by the active status of the business ruleset. Pass `true` to return only the rulesets Chargebee currently evaluates, and `false` to return only the rulesets that are switched off. When omitted, rulesets are returned irrespective of their active status.
          **Supported operators :**
          is

          **Example →**
          *active\[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
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        business_ruleset:
                          $ref: "#/components/schemas/BusinessRuleset"
                          description: Resource object representing business_ruleset
                      required:
                      - business_ruleset
                      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:
      tags:
      - business_rulesets
      summary: Create a business ruleset
      description: "Creates a business ruleset. A ruleset groups business rules so\
        \ that they can be evaluated together, in the priority order you assign, using\
        \ the strategy set in `execute_mode`.\n\nUse this operation when a decision\
        \ is made by several rules that belong together, such as all the checks that\
        \ a quote must pass or the ladder of discounts that can apply to it. Once\
        \ the ruleset exists, a single call to [Apply business rules](/docs/api/business_rules/apply-business-rules)\
        \ with its `ruleset_id` evaluates all of its rules.\n\nPassing `rules` is\
        \ optional. You can create an empty ruleset and fill it later with [Add business\
        \ rules to a ruleset](/docs/api/business_rulesets/add-business-rules-to-a-ruleset).\
        \  \n\n### Prerequisites \\& Constraints\n\n* Business rules must be enabled\
        \ for the site.\n* Each rule referenced in `rules` must already exist.  \n\
        \n### Impacts\n\n**Business ruleset**  \nA business ruleset is created with\
        \ `active` set to `false` and with the rules you passed in `rules` as its\
        \ membership.\n\nNothing is evaluated yet. A rule is evaluated through a ruleset\
        \ only when both the ruleset and the rule itself are `active`, so each one\
        \ has to be activated separately.  \n\n### Implementation Notes\n\n* Create\
        \ the rules first with [Create a business rule](/docs/api/business_rules/create-a-business-rule),\
        \ then reference their identifiers in `rules`. A `rule_id` that does not resolve\
        \ to an existing rule is rejected.\n* Call [Activate a business ruleset](/docs/api/business_rulesets/activate-a-business-ruleset)\
        \ once the membership is in place, so that Chargebee starts evaluating the\
        \ ruleset.  \n\n### Use Cases\n\nEvaluate every rule in the group  \nLeave\
        \ `execute_mode` at its default of `execute_all`, or set it to `execute_all_true`\
        \ if you only want the rules that matched to be returned. Use this when the\
        \ rules are independent of one another, such as a set of validations that\
        \ should all be reported.  \nPick the first rule that matches  \nSet `execute_mode`\
        \ to `stop_on_first_true` and assign the priorities so that the most specific\
        \ rule is evaluated first. Evaluation stops at the first rule that matches,\
        \ which makes the ruleset behave like an ordered list of alternatives.  \n\
        Stop at the first failed check  \nSet `execute_mode` to `stop_on_first_false`\
        \ so that evaluation stops at the first rule that is not satisfied. Use this\
        \ when later rules only make sense if the earlier ones passed.\n"
      operationId: create_a_business_ruleset
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                id:
                  type: string
                  deprecated: false
                  description: |
                    Unique identifier for the business ruleset. If not provided, Chargebee generates one.
                  maxLength: 100
                  example: null
                name:
                  type: string
                  deprecated: false
                  description: |
                    Display name of the business ruleset.
                  maxLength: 500
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    Description of what the business ruleset does.
                  maxLength: 1000
                  example: null
                execute_mode:
                  type: string
                  default: execute_all
                  deprecated: false
                  description: "Strategy that determines how the rules in the ruleset\
                    \ are evaluated and when evaluation stops.  \n**Default value**\n\
                    \n* `execute_all`.\n\n* execute_all - Every rule in the ruleset\
                    \ is evaluated and all the results are returned. This is the default.\n\
                    * stop_on_first_true - Evaluation stops as soon as a rule evaluates\
                    \ to `true`. The rules that come later in the evaluation order\
                    \ are not evaluated.\n* execute_all_true - Every rule in the ruleset\
                    \ is evaluated, and only the rules that evaluated to `true` are\
                    \ returned.\n* stop_on_first_false - Evaluation stops as soon\
                    \ as a rule evaluates to `false`. The rules that come later in\
                    \ the evaluation order are not evaluated.\n"
                  enum:
                  - stop_on_first_true
                  - stop_on_first_false
                  - execute_all
                  - execute_all_true
                  example: null
                rules:
                  type: array
                  deprecated: false
                  description: "The [business rules](/docs/api/business_rules) that\
                    \ make up the ruleset, along with the priorities that determine\
                    \ their positions in its evaluation order. Each entry takes the\
                    \ `rule_id` of an existing business rule and an optional `priority`;\
                    \ when `priority` is omitted, it is assigned from the position\
                    \ of the entry in the array. Pass the list as a JSON array.  \n\
                    **Constraints**\n\n* Each `rule_id` must belong to a business\
                    \ rule that already exists.\n* A `priority` can be used by only\
                    \ one rule in the ruleset. Two entries that carry the same `priority`\
                    \ are rejected.\n\n**Example →**\n`rules = [{\"rule_id\":\"custom-uuid-1\"\
                    ,\"priority\":1},{\"rule_id\":\"custom-uuid-2\",\"priority\":2}]`\n"
                  items:
                    example: null
                  example: null
              required:
              - name
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  business_ruleset:
                    $ref: "#/components/schemas/BusinessRuleset"
                    description: |
                      The business ruleset with the rules added to its membership. Its `name`, `description`, `execute_mode`, and `active` attributes are unchanged.
                required:
                - business_ruleset
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /business_rulesets/{business-ruleset-id}/activate:
    post:
      tags:
      - business_rulesets
      summary: Activate a business ruleset
      description: "Activates a business ruleset by setting its `active` attribute\
        \ to `true`, so that Chargebee evaluates the rules it contains.  \n\n### Impacts\n\
        \n**Business ruleset**  \nThe ruleset `active` attribute is set to `true`.\
        \ Applying the ruleset with [Apply business rules](/docs/api/business_rules/apply-business-rules)\
        \ evaluates the rules it contains, in their priority order, following the\
        \ strategy in `execute_mode`.\n\nActivating the ruleset does not activate\
        \ its rules. A rule is evaluated through the ruleset only when the rule itself\
        \ is also `active`.  \n\n### Implementation Notes\n\nCheck the membership\
        \ with [List rules in a business ruleset](/docs/api/business_rulesets/list-rules-in-a-business-ruleset)\
        \ before calling this operation, and activate any rule that is still switched\
        \ off with [Activate a business rule](/docs/api/business_rules/activate-a-business-rule).\
        \ Otherwise the ruleset goes live evaluating only part of its membership.\n"
      operationId: activate_a_business_ruleset
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: business-ruleset-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/business-ruleset-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  business_ruleset:
                    $ref: "#/components/schemas/BusinessRuleset"
                    description: |
                      The business ruleset with the rules added to its membership. Its `name`, `description`, `execute_mode`, and `active` attributes are unchanged.
                required:
                - business_ruleset
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /business_rulesets/{business-ruleset-id}/add_rules:
    post:
      tags:
      - business_rulesets
      summary: Add business rules to a ruleset
      description: "Adds one or more business rules to a ruleset without changing\
        \ any of its other attributes. The rules are appended to the end of the ruleset's\
        \ evaluation order, so you cannot choose their priorities here.\n\nUse this\
        \ operation to extend a ruleset that is already in use. Unlike [Update a business\
        \ ruleset](/docs/api/business_rulesets/update-a-business-ruleset), it leaves\
        \ the rules already in the ruleset in place, so you do not need to resend\
        \ the whole membership.  \n\n### Prerequisites \\& Constraints\n\n* Each rule\
        \ referenced in `rules` must already exist, and must not already belong to\
        \ the ruleset.  \n\n### Impacts\n\n**Business ruleset**  \nThe rules are appended\
        \ to the end of the ruleset's evaluation order, each given a priority above\
        \ the highest priority already in use, and `updated_at` and `updated_by` are\
        \ set. The rules already in the ruleset keep their priorities, and the `name`,\
        \ `description`, `execute_mode`, and `active` attributes of the ruleset are\
        \ unchanged.\n\nA rule can belong to more than one ruleset, so adding it here\
        \ does not remove it from any other ruleset. A rule added to an `active` ruleset\
        \ is evaluated only once the rule itself is also `active`.  \n\n### Implementation\
        \ Notes\n\nConfirm the resulting evaluation order with [List rules in a business\
        \ ruleset](/docs/api/business_rulesets/list-rules-in-a-business-ruleset),\
        \ because this operation appends rather than inserting at a position you choose.\
        \ If the new rules need to be evaluated earlier, set every priority explicitly\
        \ with [Update a business ruleset](/docs/api/business_rulesets/update-a-business-ruleset).\n"
      operationId: add_business_rules_to_a_ruleset
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: business-ruleset-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/business-ruleset-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
              properties:
                rules:
                  type: array
                  deprecated: false
                  description: "The [business rules](/docs/api/business_rules) to\
                    \ add to the ruleset. Each entry takes the `rule_id` of an existing\
                    \ business rule. Pass the list as a JSON array.\n\nTo place a\
                    \ new rule earlier in the evaluation order, set the priorities\
                    \ explicitly with [Update a business ruleset](/docs/api/business_rulesets/update-a-business-ruleset)\
                    \ instead.  \n**Impacts**\n\n* Each rule is appended to the end\
                    \ of the ruleset's evaluation order, taking a priority above the\
                    \ highest already in use, in the order the entries appear in the\
                    \ array.\n* Rules already in the ruleset keep their priorities.\
                    \  \n**Constraints**\n\n* Each `rule_id` must belong to a business\
                    \ rule that already exists.\n* A rule that is already in the ruleset\
                    \ cannot be added again.\n\n**Example →**\n`rules = [{\"rule_id\"\
                    :\"custom-uuid-3\"},{\"rule_id\":\"custom-uuid-4\"}]`\n"
                  items:
                    example: null
                  example: null
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  business_ruleset:
                    $ref: "#/components/schemas/BusinessRuleset"
                    description: |
                      The business ruleset with the rules added to its membership. Its `name`, `description`, `execute_mode`, and `active` attributes are unchanged.
                required:
                - business_ruleset
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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}/usage_summary:
    get:
      tags:
      - subscriptions
      summary: Retrieve usage summary for a subscription
      description: "Retrieves aggregated usage data for a metered feature in a subscription\
        \ over a specified reporting window.\n\nUnlike [Retrieve Current Usage Charges\
        \ for a Subscription](/docs/api/usage_charges/retrieve-usage-charges-for-a-subscription)\
        \ API, which returns the current unbilled usage snapshot including charges,\
        \ this endpoint returns aggregated usage for a requested timeframe.\n\nUse\
        \ this endpoint to power experiences such as:\n\n* plotting daily, weekly,\
        \ or monthly usage trends\n* analyzing feature adoption over time\n* comparing\
        \ recent usage against earlier periods\n* showing historical usage summaries\
        \ to subscribers\n\n### What this endpoint returns\n\nReturns usage summary\
        \ entries for the requested feature within the specified timeframe.\n\nIf\
        \ `timeframe_start` and `timeframe_end` are not provided, the reporting range\
        \ **defaults to the start of the subscription's current term for `timeframe_start`\
        \ and the current time for `timeframe_end`.**\n\n### How aggregation works\n\
        \n* If `window_size` is omitted, the response returns a single aggregate for\
        \ the full reporting range.\n* If `window_size` is provided, the response\
        \ returns one aggregated entry for each window in the reporting range.\n\n\
        Aggregation windows begin at `timeframe_start` and continue consecutively\
        \ until `timeframe_end`.\n\nThe usages in the window will be bucketed into\
        \ **rolling windows** aligned to `timeframe_start`, **not to calendar boundaries**.\n\
        \n#### Example\n\nIf:\n\n* `timeframe_start` is `May 10 10:00:00 UTC`\n* `timeframe_end`\
        \ is `June 10 10:00:00 UTC`\n* `window_size` is `day`\n\nThe response returns\
        \ windows such as:\n\n* `May 10 10:00:00 UTC` → `May 11 10:00:00 UTC`\n* `May\
        \ 11 10:00:00 UTC` → `May 12 10:00:00 UTC`\n\nand continues in the same pattern\
        \ until the final window:\n\n* `June 9 10:00:00 UTC` → `June 10 10:00:00 UTC`\n\
        \nIf you need calendar-aligned reporting, set `timeframe_start` to the required\
        \ boundary. For example, use `00:00:00 UTC` for daily reporting aligned to\
        \ calendar days, or the first day of the month at `00:00:00 UTC` for monthly\
        \ reporting aligned to calendar months.\n\nEach aggregation window follows\
        \ inclusive-exclusive semantics:\n\n* `aggregated_from` is inclusive\n* `aggregated_till`\
        \ is exclusive\n\nIn other words, each window is represented as `aggregated_from`\
        \ and `aggregated_till`.\n\nThis means:\n\n* an event with a timestamp exactly\
        \ equal to `aggregated_from` is included in that window\n* an event with a\
        \ timestamp exactly equal to `aggregated_till` is excluded from that window\
        \ and counted in the next window, if one exists\n* an event with a timestamp\
        \ exactly equal to `timeframe_end` is excluded\n\nThese inclusive-exclusive\
        \ boundaries ensure that windows do not overlap and that events on boundaries\
        \ are never double-counted.  \n\n### Distinct-count behavior\n\nIf a feature\
        \ uses distinct-count aggregation, the distinct count is evaluated separately\
        \ within each returned window.\n\nThis means the same entity can be counted\
        \ once in multiple windows if it appears in each of them.\n\n#### Example\n\
        \nIf the same user appears in both:\n\n* one daily window on **Jan 1**\n*\
        \ another daily window on **Jan 2**\n\nThat user is counted once in the Jan\
        \ 1 aggregate and once in the Jan 2 aggregate.\n"
      operationId: retrieve_usage_summary_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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: feature_id
        in: query
        description: |
          Unique identifier of the metered [feature](/docs/api/features/feature-object#id)
          for which usage is aggregated
        required: true
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          deprecated: false
          maxLength: 100
          example: null
      - name: window_size
        in: query
        description: |
          Specifies the aggregation interval for the reporting window. If omitted,
          the response includes a single aggregate for the entire reporting window.

          * day - Aggregates usage by day.
          * minute - Aggregates usage by minute.
          * hour - Aggregates usage by hour.
          * month - Aggregates usage by month.
          * week - Aggregates usage by week.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          deprecated: false
          enum:
          - month
          - week
          - day
          - hour
          - minute
          example: null
      - name: timeframe_start
        in: query
        description: |
          Start of the reporting window, in Unix epoch seconds. If not provided,
          defaults to the start of the current subscription term.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: unix-time
          deprecated: false
          example: null
      - name: timeframe_end
        in: query
        description: |
          End of the reporting window, in Unix epoch seconds. If not provided,
          defaults to the current time
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: unix-time
          deprecated: false
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        usage_summary:
                          $ref: "#/components/schemas/UsageSummary"
                          description: Resource object representing usage_summary
                      required:
                      - usage_summary
                      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}/usage_charges:
    get:
      tags:
      - subscriptions
      summary: Retrieve usage charges for a subscription
      description: "Returns the current, unbilled usage charges for the metered features\
        \ on a subscription.\n\nThis endpoint returns usage for each feature's current\
        \ usage period. If entitlement or pricing changes during that period, the\
        \ same feature can appear multiple times, with one usage_charge object returned\
        \ for each interval.\n\nUse this endpoint to present the below information\
        \ in your portal or customer-facing experiences.\n\n* current usage to date\n\
        * included entitlement\n* on-demand or overage usage, if any\n* the current\
        \ chargeable amount, when applicable\n\nThis endpoint does not return historical,\
        \ billed, or invoice-backed usage.\n\nThis endpoint returns usage for the\
        \ **active usage window of each feature**, not necessarily for the full subscription\
        \ term.\n\nTo read the response correctly, keep these three concepts in mind:\n\
        \n* **Subscription current term**: The overall billing term of the subscription,\
        \ usually defined by the plan.\n* **Current usage period**: The active period\
        \ for which usage is currently accruing and has not yet been billed for a\
        \ feature.\n* **Usage interval**: A continuous segment within the current\
        \ usage period where entitlement and pricing remain unchanged.\n\nRead more\
        \ about time concepts  \n\n### 1. Subscription current term {#transfer-more-content}\n\
        \nThe **subscription current term** is the broader billing term of the subscription.\
        \ It is usually determined by the lowest-frequency item on the subscription,\
        \ typically the plan.\n\nIt is included as context only.  \nThis endpoint\
        \ does not return usage for the full subscription term unless that also happens\
        \ to be the feature's active usage window.\n\n### 2. Current usage period\n\
        \nThe **current usage period** is the time range in which usage is actively\
        \ accruing and has not yet been billed for a feature.\n\nThis is the primary\
        \ time window used by the API.\n\nHow it is determined\n\n**Feature with metered\
        \ addon -** The current usage period is the overage addon's billing period.\n\
        \n**Feature without metered addon -** The current usage period is the currently\
        \ active entitlement window for that feature.\n\n### 3. Usage intervals\n\n\
        A **current usage period** may be returned as a single interval or as multiple\
        \ intervals.\n\nA **usage interval** is a continuous segment where the feature's\
        \ entitlement and pricing remain unchanged.\n\nIf nothing changes during the\
        \ period, the API returns one entry for that feature.\n\nIf something changes,\
        \ the API returns multiple entries for the same feature.\n\n#### Changes that\
        \ can create multiple intervals\n\n* Entitlement changes mid-period\n* A metered\
        \ addon is added, removed, or expires\n* Overage pricing changes mid-period\n\
        * Pricing configuration changes during the active period\n\nRead more about\
        \ example scenario  \n\n### Example Scenario {#read-more-content}\n\n* **Base\
        \ Plan:** Includes 100 GB/month (Starts 1 Jan).\n* **Mid-Period Change: Addon\
        \ #1** (+200 GB/month) is added on **16 Jan 09:00:00**\n* **Snapshot Date:**\
        \ API is called on **20 Jan.**\n\n**Current Usage Period: 1 Jan 00:00:00 --\
        \ 31 Jan 23:59:59**\n\n#### Usage Interval 1: 1 Jan 00:00:00 -- 16 Jan 08:59:59\n\
        \nThis interval reflects the subscription's state before the addon was active.\n\
        \n* **Entitlement:** 100 GB (Base Plan)\n* **Usage:** 80 GB consumed\n* **Carry-forward:**\
        \ The remaining 20 GB of the base plan is carried into the next interval.\n\
        \n#### Usage Interval 2: 16 Jan 09:00:00 -- 20 Jan 23:59:59\n\nThis interval\
        \ begins the moment the entitlement context changes and ends at the response\
        \ snapshot (20 Jan).\n\n* **Entitlement:** 220 GB total\n  * *Calculation:\
        \ 20 GB (remaining from Base Plan) + 200 GB (Addon #1)*\n* **Usage:** 100\
        \ GB consumed during this specific 4-day window.\n* **Note:** Although the\
        \ billing month ends on 31 Jan, the `usage_to` date is capped at the snapshot\
        \ date (Jan 20).\n\nscreenshot\\|/images/retrieve_usage_charges_for_subscription_1.png\n\
        \n#### Response Behaviour\n\nThe API returns separate usage charge objects\
        \ for each interval where entitlement remains stable.\n\n1. **First object\
        \ - Initial Plan Period**\n\n   Covers the storage feature from **1 Jan 00:00:00**\
        \ to **16 Jan 08:59:59**.\n\n   During this interval, total entitlement is\
        \ **100 GB**.\n\n   **80 GB** is consumed, so **20 GB** remains and carries\
        \ forward into the next interval.\n2. **Second object - Post-Addon Addition**\n\
        \n   * Covers the storage feature from **16 Jan 09:00:00** to **20 Jan 23:59:59**.\n\
        \   * During this interval, total entitlement is **220 GB** , calculated as:\n\
        \     * **200 GB** from Addon #1\n     * **20 GB** carried forward from the\
        \ plan\n   * **100 GB** is consumed out of 220 GB; hence, no charges.\n\n\
        ##### **Response for Jan 20**\n\n```bg-gray-100 text-gray-800 font-medium\
        \ border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap\n\
        \"list\": [\n        \"usage_charge\": {\n            \"subscription_id\"\
        :\"sub-001\",\n            \"feature_id\": \"storage_abc\",\n            \"\
        usage_from\":\"1 Jan 00:00:00\", // For readability, the exact dates are shown\
        \ here; the actual response will have timestamps.\n            \"usage_to\"\
        :\"16 Jan 08:59:59\",\n            \"included_usage\": \"100\",\n        \
        \    \"total_usage\": \"80\",\n            \"on_demand_usage\": \"0\",   \
        \           \n            \"amount\": \"0\",\n            \"metered_item_price_id\"\
        :\"storage_001\"\n          },\n        \"usage_charge\": {\n            \"\
        subscription_id\":\"sub-001\",\n            \"feature_id\": \"storage_abc\"\
        ,\n            \"usage_from\":\"16 Jan 09:00:00\",\n            \"usage_to\"\
        :\"20 Jan 23:59:59\",\n            \"included_usage\": \"220\",\n        \
        \    \"total_usage\": \"100\",\n            \"on_demand_usage\": \"0\",  \
        \                \n            \"amount\": \"0\",\n            \"metered_item_price_id\"\
        :\"storage_001\"\n          }\n  ]\n```\n\n**Note:** For readability, the\
        \ example above uses dates such as `1 Jan` and `16 Jan`. In the actual API\
        \ response, `usage_from` and `usage_to` are returned as timestamps.\n\nIntegration\
        \ notes\n-----------------\n\nWhen processing the response:\n\n* Group entries\
        \ by `feature_id`\n* Sort intervals by `usage_from`\n* Do not assume one entry\
        \ per feature\n* Use `amount` only when present\n* Treat the response as a\
        \ snapshot of current unbilled usage\n"
      operationId: retrieve_usage_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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
      - name: limit
        in: query
        description: |
          The number of resources to be returned.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        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.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: feature_id
        in: query
        description: |
          optional, string filter

          Unique identifier of the metered [feature](/docs/api/features/feature-object#id) for which usage is tracked.
          **Supported operators :**
          is

          **Example →**
          *feature_id\[is\] = "fea-user-licenses"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          example: feat_123
          properties:
            is:
              type: string
              minLength: 1
              example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        usage_charge:
                          $ref: "#/components/schemas/UsageCharge"
                          description: Resource object representing usage_charge
                      required:
                      - usage_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: []
  /subscriptions/{subscription-id}/applicable_alerts:
    get:
      tags:
      - subscriptions
      summary: List applicable alerts for a subscription
      description: "Returns the effective set of alert configurations for a given\
        \ subscription. This includes global alerts (filtered by the subscription's\
        \ plan) and any subscription-scoped alerts, giving you a single view of all\
        \ threshold rules in force.\n\nUse this endpoint when building subscription\
        \ dashboards or evaluating which alerts apply to a specific customer.  \n\
        **Note:** This endpoint returns alert configurations only. To check the runtime\
        \ state (whether alerts are currently `within_limit` or `in_alarm`), use [List\
        \ alert statuses for a subscription](/docs/api/alert_statuses/list-alert-statuses-for-a-subscription).\n"
      operationId: list_applicable_alerts_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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
      - name: limit
        in: query
        description: |
          optional, integer

          Maximum number of results to return.

          **Example →**
          *limit = 25*
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |
          optional, string

          Pagination cursor returned by a previous list call. Use the `next_offset` value from the previous response.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: status
        in: query
        description: |
          optional, enumerated string filter

          Filter by [status](/docs/api/alerts/alert-object#status).

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

          Filter by [type](/docs/api/alerts/alert-object#type). Supported values are `usage_exceeded`, `spend_exceeded`, and `credit_balance_dropped`.

          **Example →**
          *type\[is\] = "credit_balance_dropped"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            is:
              type: string
              description: |-
                * `usage_exceeded` - usage_exceeded
                * `spend_exceeded` - spend_exceeded
                * `credit_balance_dropped` - credit_balance_dropped
              enum:
              - usage_exceeded
              - spend_exceeded
              - credit_balance_dropped
              example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        alert:
                          $ref: "#/components/schemas/Alert"
                          description: Resource object representing alert
                      required:
                      - alert
                      example: null
                    example: null
                  next_offset:
                    type: string
                    description: |
                      Returned only if more results are available. Pass this value as `offset` in the next request to fetch the next page.
                    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: []
  /alerts/{alert-id}:
    get:
      tags:
      - alerts
      summary: Retrieve an alert
      description: "Retrieves a single alert configuration by `alert_id`. This returns\
        \ the rule definition only and does not include runtime evaluation state.\
        \  \n**Note:** To check whether a subscription is currently `within_limit`\
        \ or `in_alarm` for this alert, use [List alert statuses for an alert](/docs/api/alert_statuses/list-alert-statuses-for-an-alert).\n"
      operationId: retrieve_an_alert
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: alert-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/alert-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  alert:
                    $ref: "#/components/schemas/Alert"
                    description: |
                      Resource object representing alert.
                required:
                - alert
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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:
      tags:
      - alerts
      summary: Update an alert
      description: "Updates an existing alert configuration. Use this to change the\
        \ `threshold` values or toggle the `status` between `enabled` and `disabled`.\
        \  \n\n### Impacts\n\n**Alert status on threshold change**  \nWhen the threshold\
        \ is updated for an alert, the `alarm_status` for all impacted subscriptions\
        \ is reset to `within_limit`. The alert is re-evaluated the next time Chargebee\
        \ processes data relevant to that alert.  \n**Alert status on disable**  \n\
        When the alert `status` is changed to `disabled`, all further evaluation stops.\
        \ No webhooks are fired for this alert while it is disabled. When the alert\
        \ is re-enabled, the `alarm_status` is set to `within_limit` and is re-evaluated\
        \ when Chargebee next processes relevant data for the alert.\n"
      operationId: update_an_alert
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: alert-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/alert-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                status:
                  type: string
                  default: enabled
                  deprecated: false
                  description: |
                    Set to `enabled` to activate the alert or `disabled` to deactivate it.

                    * enabled - The alert is active and will trigger when the threshold is breached.
                    * disabled - The alert is inactive and will not trigger.
                  enum:
                  - enabled
                  - disabled
                  example: null
                threshold:
                  type: object
                  deprecated: false
                  description: |
                    The threshold configuration that defines when this alert fires. Only the fields provided are updated.
                  properties:
                    mode:
                      type: string
                      deprecated: false
                      description: |
                        How the threshold `value` is interpreted. `usage_exceeded` alerts support `percentage` or `absolute`. `spend_exceeded` and `credit_balance_dropped` alerts always use `absolute`.

                        * percentage - The threshold `value` represents a percentage (0-100) of the plan or feature quota. Supported only for `usage_exceeded` alerts.
                        * absolute - The threshold `value` represents an absolute quantity: a usage quantity for `usage_exceeded`, an overage spend amount in `currency_code` for `spend_exceeded`, or a credit-balance floor for `credit_balance_dropped`.
                      enum:
                      - absolute
                      - percentage
                      example: null
                    value:
                      type: number
                      format: double
                      deprecated: false
                      description: |
                        The numeric threshold at which the alert fires. For `percentage` mode, this must be between 0 and 100 inclusive. For `absolute` mode, this must be \>= 0.
                      example: null
                  example: null
              example: null
            encoding:
              threshold:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  alert:
                    $ref: "#/components/schemas/Alert"
                    description: |
                      Resource object representing alert.
                required:
                - alert
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /alerts/{alert-id}/delete:
    post:
      tags:
      - alerts
      summary: Delete an alert
      description: "Deletes an alert configuration. Only subscription-scoped alerts\
        \ can be deleted using this endpoint.  \n**Important**\n\nThis operation cannot\
        \ delete global alerts. To stop a global alert from firing, [update the alert](/docs/api/alerts/update-an-alert)\
        \ and set `status` to `disabled` instead.  \n\n### Impacts\n\n**Alert configuration**\
        \  \nThe alert configuration is permanently deleted from the system and cannot\
        \ be recovered.  \n**Alert statuses**  \nAll [alert statuses](/docs/api/alert_statuses)\
        \ associated with this alert are removed. No further evaluation takes place,\
        \ and no `alert_status_changed` webhooks are fired for this alert going forward.\n"
      operationId: delete_an_alert
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: alert-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/alert-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  alert:
                    $ref: "#/components/schemas/Alert"
                    description: |
                      Resource object representing alert.
                required:
                - alert
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /alerts:
    get:
      tags:
      - alerts
      summary: List alerts
      description: "Returns a list of alert configurations meeting **all** the conditions\
        \ specified in the filter parameters below. Results include both global and\
        \ subscription-scoped alerts.  \n**Note:** To retrieve only the alerts that\
        \ are in effect for a specific subscription (after resolving global rules\
        \ and overrides), use [List applicable alerts](/docs/api/alerts/list-applicable-alerts-for-a-subscription)\
        \ instead.\n"
      operationId: list_alerts
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: |
          optional, integer

          Maximum number of results to return.

          **Example →**
          *limit = 10*
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |
          optional, string

          Pagination cursor returned by a previous list call. Use the `next_offset` value from the previous response.

          **Example →**
          *offset = "MjAyNC0xMi0yMFQxMjozMjo1MSswMDowMHw5OTk5OTk5OTk="*
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: id
        in: query
        description: |
          optional, string filter

          Filter alerts by [id](/docs/api/alerts/alert-object#id).

          **Example →**
          *id\[in\] = "alert___dev__3Nl7purV3LwbKYH"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            in:
              type: string
              pattern: "^\\[(.*)(,.*)*\\]$"
              example: null
          example: null
      - name: type
        in: query
        description: |
          optional, enumerated string filter

          Filter by [type](/docs/api/alerts/alert-object#type). Supported values are `usage_exceeded`, `spend_exceeded`, and `credit_balance_dropped`.

          **Example →**
          *type\[is\] = "credit_balance_dropped"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            is:
              type: string
              description: |-
                * `usage_exceeded` - usage_exceeded
                * `spend_exceeded` - spend_exceeded
                * `credit_balance_dropped` - credit_balance_dropped
              enum:
              - usage_exceeded
              - spend_exceeded
              - credit_balance_dropped
              example: null
          example: null
      - name: subscription_id
        in: query
        description: |
          optional, string filter

          Filter by [subscription_id](/docs/api/alerts/alert-object#subscription_id) to find alerts scoped to a specific subscription.

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

          Filter by [status](/docs/api/alerts/alert-object#status).

          **Example →**
          *status\[is\] = "enabled"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            is:
              type: string
              description: |-
                * `enabled` - enabled
                * `disabled` - disabled
              enum:
              - enabled
              - disabled
              example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        alert:
                          $ref: "#/components/schemas/Alert"
                          description: Resource object representing alert
                      required:
                      - alert
                      example: null
                    example: null
                  next_offset:
                    type: string
                    description: |
                      Returned only if more results are available. Pass this value as `offset` in the next request to fetch the next page.
                    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:
      tags:
      - alerts
      summary: Create an alert
      description: "Creates a new alert configuration. Depending on `type`, the alert\
        \ can monitor usage, spend, or credit balance, and it can be [global or subscription-scoped](/docs/api/alerts/alert-object#global-vs-subscription-alerts)\
        \ depending on whether `subscription_id` is provided.  \n**Note:** Creating\
        \ an alert defines the threshold rule only. After an alert is created, Chargebee\
        \ begins evaluating it as relevant billing data changes are processed. Alert\
        \ statuses are created and updated during alert evaluation. The runtime evaluation\
        \ state for each subscription is available via the [Alert Status](/docs/api/alert_statuses)\
        \ endpoints.  \n\n### Prerequisites \\& Constraints\n\n* For `usage_exceeded`\
        \ alerts, `metered_feature_id` must reference an existing metered feature\
        \ configured on your site.\n* For `spend_exceeded` alerts, provide `currency_code`.\n\
        * For `credit_balance_dropped` alerts, provide `unit_id` to identify the credit\
        \ unit the alert applies to.\n* Provide only the input that matches the alert\
        \ `type`: `metered_feature_id`, `currency_code`, and `unit_id` are mutually\
        \ exclusive.\n* For `spend_exceeded` alerts, `threshold` `mode` is optional\
        \ and defaults to `absolute` when omitted; if provided, it must be `absolute`.\
        \ For `credit_balance_dropped` alerts, `threshold` `mode` must be `absolute`.\
        \ Only `usage_exceeded` alerts support `percentage` mode.\n* For `filter_conditions`,\
        \ only `plan_price_id` is supported as the `field`, with operator `equals`\
        \ or `not_equals`.  \n\n### Use Cases\n\nCreate a usage alert  \nSet `type`\
        \ to `usage_exceeded` and provide `metered_feature_id`. Use a `percentage`\
        \ threshold to fire relative to the plan or feature quota (for example, at\
        \ 90%), or an `absolute` threshold to fire at a specific usage quantity. \
        \ \nCreate a spend alert  \nSet `type` to `spend_exceeded` and provide `currency_code`.\
        \ The alert monitors the usage-based spend accumulated from metered addons\
        \ (counting only usage beyond the included entitlement) and fires when it\
        \ reaches the `absolute` threshold amount in that currency.  \nCreate a credit\
        \ balance alert  \nSet `type` to `credit_balance_dropped` and provide `unit_id`.\
        \ The alert fires when the [credit balance](/docs/api/ledger_account_balances)\
        \ for that unit drops to or below the `absolute` threshold.\n"
      operationId: create_an_alert
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                type:
                  type: string
                  deprecated: false
                  description: |
                    The type of alert to create. Determines what the alert measures, which input it requires, and how the `threshold` is interpreted.

                    * credit_balance_dropped - The alert fires when the [credit balance](/docs/api/ledger_account_balances) for the configured credit unit drops to or below the configured threshold. The `threshold` mode is always `absolute`.
                    * usage_exceeded - The alert fires when usage of the [metered feature](/docs/api/usages) (identified by `metered_feature_id`) reaches or exceeds the configured threshold. Supports both `percentage` and `absolute` threshold modes.
                    * spend_exceeded - The alert fires when the total usage-based spend accumulated from metered addons reaches or exceeds the configured threshold. Only spend from usage beyond the included entitlement is counted. See [usage charges](/docs/api/usage_charges) for how overage spend is computed. The `threshold` mode is always `absolute`.
                  enum:
                  - usage_exceeded
                  - spend_exceeded
                  - credit_balance_dropped
                  example: null
                name:
                  type: string
                  deprecated: false
                  description: |
                    A human-readable name for the alert. Maximum 50 characters.
                  maxLength: 50
                  example: null
                description:
                  type: string
                  deprecated: false
                  description: |
                    An optional description providing additional context about the alert. Maximum 65,000 characters.
                  maxLength: 65000
                  example: null
                metered_feature_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the [metered feature](/docs/api/usages) that the alert should monitor. Required when `type` is `usage_exceeded`; do not set it for other alert types.
                  maxLength: 50
                  example: null
                currency_code:
                  type: string
                  deprecated: false
                  description: |
                    The ISO [currency code](/docs/api/currencies/currency-object#currency_code) in which the metered-addon overage spend is measured. Required when `type` is `spend_exceeded`; do not set it for other alert types.
                  maxLength: 3
                  example: null
                unit_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the credit unit that the alert should monitor. Required when `type` is `credit_balance_dropped`; do not set it for other alert types.
                  maxLength: 50
                  example: null
                subscription_id:
                  type: string
                  deprecated: false
                  description: |
                    The identifier of the [subscription](/docs/api/subscriptions) to scope this alert to. If omitted, the alert is created as a global alert. If provided, `filter_conditions` must not be set.
                  maxLength: 50
                  example: null
                meta:
                  type: string
                  deprecated: false
                  description: |
                    An optional string field for storing custom metadata with the alert (for example, JSON serialized by your integration). Maximum 65,000 characters.
                  maxLength: 65000
                  example: null
                threshold:
                  type: object
                  deprecated: false
                  description: |
                    The threshold configuration that defines when this alert fires.
                  properties:
                    mode:
                      type: string
                      deprecated: false
                      description: |
                        How the threshold `value` is interpreted. `usage_exceeded` alerts support `percentage` or `absolute`. For `spend_exceeded` alerts, `mode` is optional and defaults to `absolute` when omitted; if provided, it must be `absolute`. For `credit_balance_dropped` alerts, `mode` must be `absolute`.

                        * percentage - The threshold `value` represents a percentage (0-100) of the plan or feature quota. Supported only for `usage_exceeded` alerts.
                        * absolute - The threshold `value` represents an absolute quantity: a usage quantity for `usage_exceeded`, an overage spend amount for `spend_exceeded`, or a credit-balance floor for `credit_balance_dropped`. For `spend_exceeded`, the amount is expressed in the major units of `currency_code` (for example, dollars---not cents---for `USD`, so `500.0` means 500 USD).
                      enum:
                      - absolute
                      - percentage
                      example: null
                    value:
                      type: number
                      format: double
                      deprecated: false
                      description: |
                        The numeric threshold at which the alert fires. For `percentage` mode, this must be between 0 and 100 inclusive. For `absolute` mode, this must be \>= 0.
                      example: null
                  required:
                  - value
                  example: null
                filter_conditions:
                  type: object
                  deprecated: false
                  description: |
                    An array of conditions that restrict which subscriptions a global alert applies to. Multiple conditions are evaluated with OR logic. Cannot be set when `subscription_id` is provided.
                  properties:
                    field:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The subscription attribute to filter on. Currently only `plan_price_id` is supported.

                          * plan_price_id - Filters by the plan price associated with the subscription.
                        enum:
                        - plan_price_id
                        example: null
                      example: null
                    operator:
                      type: array
                      items:
                        type: string
                        deprecated: false
                        description: |
                          The comparison operator for the filter condition.

                          * not_equals - The subscription attribute must not equal the specified `value`.
                          * equals - The subscription attribute must equal the specified `value`.
                        enum:
                        - equals
                        - not_equals
                        example: null
                      example: null
                    value:
                      type: array
                      description: |
                        The value to compare against, for example, a specific plan price identifier. Maximum 50 characters.
                      items:
                        type: string
                        deprecated: false
                        maxLength: 50
                        example: null
                      example: null
                  example: null
              required:
              - name
              - type
              example: null
            encoding:
              filter_conditions:
                style: deepObject
                explode: true
              threshold:
                style: deepObject
                explode: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  alert:
                    $ref: "#/components/schemas/Alert"
                    description: |
                      Resource object representing alert.
                required:
                - alert
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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}/alert_statuses:
    get:
      tags:
      - subscriptions
      summary: List alert statuses for a subscription
      description: "Returns the runtime state of all alerts for a given subscription.\
        \ Each entry in the response indicates whether the subscription is `within_limit`\
        \ or `in_alarm` for a specific [alert](/docs/api/alerts).\n\nUse this endpoint\
        \ to build a subscription-level dashboard showing which thresholds have been\
        \ breached and when.  \n**Note:** This endpoint returns runtime state, not\
        \ alert configurations. To retrieve the alert rules that apply to a subscription,\
        \ use [List applicable alerts](/docs/api/alerts/list-applicable-alerts-for-a-subscription).\n"
      operationId: list_alert_statuses_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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          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
      - name: limit
        in: query
        description: |
          optional, integer

          Maximum number of results to return.

          **Example →**
          *limit = 10*
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |
          optional, string

          Pagination cursor returned by a previous list call. Use the `next_offset` value from the previous response.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: alarm_status
        in: query
        description: |
          optional, enumerated string filter

          Filter by [alarm_status](/docs/api/alert_statuses/alert-status-object#alarm_status) to find alerts in a specific runtime state.

          **Example →**
          *alarm_status\[is\] = "in_alarm"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            is:
              type: string
              description: |-
                * `within_limit` - WITHIN_LIMIT
                * `in_alarm` - IN_ALARM
              enum:
              - within_limit
              - in_alarm
              example: null
          example: null
      - name: alert_id
        in: query
        description: |
          optional, string filter

          Filter by [alert_id](/docs/api/alert_statuses/alert-status-object#alert_id) to find the status for a specific alert.

          **Example →**
          *alert_id\[is\] = "alert___dev__3Nl7purV3LwbKYH"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            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:
                        alert_status:
                          $ref: "#/components/schemas/AlertStatus"
                          description: Resource object representing alert_status
                      required:
                      - alert_status
                      example: null
                    example: null
                  next_offset:
                    type: string
                    description: |
                      Returned only if more results are available. Pass this value as `offset` in the next request to fetch the next page.
                    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: []
  /alerts/{alert-id}/alert_statuses:
    get:
      tags:
      - alerts
      summary: List alert statuses for an alert
      description: "Returns the runtime state of a specific [alert](/docs/api/alerts)\
        \ across all impacted subscriptions. Each entry indicates whether a subscription\
        \ is `within_limit` or `in_alarm` for the given alert.\n\nUse this endpoint\
        \ to monitor which subscriptions are currently breaching a threshold, for\
        \ example when building internal dashboards or CSM workflows.  \n\n### Prerequisites\
        \ \\& Constraints\n\n* The `alert_id` must reference a global alert. Subscription-scoped\
        \ alerts return a 400 error since they apply to only one subscription ---\
        \ use [List alert statuses for a subscription](/docs/api/alert_statuses/list-alert-statuses-for-a-subscription)\
        \ instead.\n"
      operationId: list_alert_statuses_for_an_alert
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: alert-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/alert-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      - name: limit
        in: query
        description: |
          optional, integer

          Maximum number of results to return.

          **Example →**
          *limit = 25*
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: |
          optional, string

          Pagination cursor returned by a previous list call. Use the `next_offset` value from the previous response.
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: alarm_status
        in: query
        description: |
          optional, enumerated string filter

          Filter by [alarm_status](/docs/api/alert_statuses/alert-status-object#alarm_status) to find subscriptions in a specific runtime state.

          **Example →**
          *alarm_status\[is\] = "in_alarm"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            is:
              type: string
              description: |-
                * `within_limit` - WITHIN_LIMIT
                * `in_alarm` - IN_ALARM
              enum:
              - within_limit
              - in_alarm
              example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        alert_status:
                          $ref: "#/components/schemas/AlertStatus"
                          description: Resource object representing alert_status
                      required:
                      - alert_status
                      example: null
                    example: null
                  next_offset:
                    type: string
                    description: |
                      Returned only if more results are available. Pass this value as `offset` in the next request to fetch the next page.
                    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: []
  /ledger_account_balances:
    get:
      tags:
      - ledger_account_balances
      summary: List ledger account balances
      description: |
        Returns a paginated list of real-time credit balance snapshots for a subscription. Each item in the list is a [ledger_account_balance](/docs/api/ledger_account_balances) object, identified by a unique combination of `subscription_id, unit_id, unit_type`.
      operationId: list_ledger_account_balances
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: "Specifies the maximum number of resources to return per page.\
          \  \n**Default and Hard Cap**\n\n* Optional parameter; if omitted, a server-defined\
          \ default is applied.\n* Values exceeding the server's maximum limit are\
          \ capped (clamped) to the allowed maximum.\n\n**Example →**\n*limit = \"\
          50\"*\n"
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: "Opaque cursor indicating the current position in the result\
          \ set for pagination.  \n**Behavior**\n\n* To fetch the next page, pass\
          \ the `next_offset` value returned in the previous response.\n* The value\
          \ is opaque and must not be parsed, modified, or constructed manually.\n\
          \n**Example →**\n*offset = \"\\[\"1771176208000\",\"96000000006\"\\]\"*\n"
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: subscription_id
        in: query
        description: |
          required, string filter

          Filters results by subscription identifier. This is the subscription whose credit grant balances you are listing.

          **Supported operators :** is

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

          Filters results by unit identifier. For example, a credit unit id such as `ai_credits`.

          **Supported operators :** is

          **Example →**
          *unit_id\[is\] = "ai_credits"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            is:
              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:
                        ledger_account_balance:
                          $ref: "#/components/schemas/LedgerAccountBalance"
                          description: Resource object representing ledger_account_balance
                      required:
                      - ledger_account_balance
                      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: []
  /ledger_operations/release_authorization:
    post:
      tags:
      - ledger_operations
      summary: Release authorization
      description: "The release_authorization operation releases previously held credits\
        \ back to the usable balance, effectively canceling an existing authorization\
        \ (hold).  \n**API Behavior**\n\n* Reverses an earlier `authorize` operation.\n\
        * Moves credits from held (reserved) → usable balance.\n* No consumption occurs\
        \ as part of this operation.\n* Always releases the entire remaining held\
        \ amount; partial releases are not supported.\n* Once released, the hold is\
        \ considered closed.  \n**Requirements**\n\nRequires the `authorization_id`\
        \ of the original authorize request.  \n**Business Use Cases**\n\nCancellation\
        \ flows\nWhen an authorized action is no longer needed.\n\nFailure recovery\n\
        Downstream processing fails after authorization.\n\nTimeout handling\nManual\
        \ alternative to auto-release on hold expiry.  \n**Usage**\n\nEnsures held\
        \ credits are fully returned to the usable balance, preventing funds from\
        \ remaining locked.\n\nThe response returns `ledger_operations` (and, for\
        \ compatibility, a deprecated singular `ledger_operation`), the updated `ledger_account_balance`,\
        \ the affected `grant_blocks`, and the `ledger_entries` recorded by this operation.\n"
      operationId: release_authorization
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                authorization_id:
                  type: string
                  deprecated: false
                  description: "Identifier of the original `authorize` operation whose\
                    \ hold is being released.  \n**Behavior**\n\n* Must reference\
                    \ a valid and active hold created via an `authorize` request.\n\
                    * Must match the `ledger_operation_id` used in the original `authorize`\
                    \ call.\n"
                  maxLength: 50
                  example: null
                id:
                  type: string
                  deprecated: false
                  description: "Optional client-supplied identifier for this release_authorization\
                    \ operation.  \n**Behavior**\n\n* When provided, must uniquely\
                    \ identify this operation across the entire ledger.\n* Should\
                    \ not conflict with any other operation, regardless of type.\n"
                  maxLength: 50
                  example: null
                ledger_operation_timestamp:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: "Unix timestamp (in seconds) representing when the\
                    \ release_authorization occurred in the upstream system.  \n**Usage**\n\
                    \n* Used for period attribution, grace-period eligibility, and\
                    \ reporting accuracy.  \n**Note**\n\nLate or out-of-order submissions\
                    \ appear in arrival order, while attribution and eligibility logic\
                    \ rely on `ledger_operation_timestamp`.\n"
                  example: null
                metadata:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: "Optional opaque JSON object carrying additional business\
                    \ context.  \n**Behavior**\n\n* Stored as-is and returned verbatim\
                    \ by the system.\n* Not interpreted, validated, or indexed by\
                    \ the system.\n"
                  example: null
              required:
              - authorization_id
              - ledger_operation_timestamp
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  ledger_operation:
                    $ref: "#/components/schemas/LedgerOperation"
                    description: |
                      **Deprecated.** Use [`ledger_operations`](#ledger_operations) instead. The single [`ledger_operation`](/docs/api/ledger_operations) resulting from this capture_authorization. Retained for backward compatibility.
                  ledger_operations:
                    type: array
                    description: |
                      The resulting [`ledger_operations`](/docs/api/ledger_operations) for this capture_authorization. Array of one or more ledger operations.
                    items:
                      $ref: "#/components/schemas/LedgerOperation"
                      description: Resource object representing ledger_operation
                    example: null
                  ledger_account_balance:
                    $ref: "#/components/schemas/LedgerAccountBalance"
                    description: |
                      Summarized real-time [`ledger_account_balance`](/docs/api/ledger_account_balances) after this capture_authorization.
                  grant_blocks:
                    type: array
                    description: |
                      The [`grant_blocks`](/docs/api/grant_blocks) affected by this operation, each reflecting its updated balances after the operation.
                    items:
                      $ref: "#/components/schemas/GrantBlock"
                      description: Resource object representing grant_block
                    example: null
                  ledger_entries:
                    type: array
                    description: |
                      The [`ledger_entries`](/docs/api/ledger_entries) recorded by this operation --- immutable, per-grant-block movements (typically `debit`, and `unhold` when releasing any unused hold) that make up this capture_authorization.
                    items:
                      $ref: "#/components/schemas/LedgerEntry"
                      description: Resource object representing ledger_entry
                    example: null
                required:
                - grant_blocks
                - ledger_account_balance
                - ledger_entries
                - ledger_operations
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /ledger_operations/capture:
    post:
      tags:
      - ledger_operations
      summary: Capture
      description: "The capture operation immediately consumes credits for a completed\
        \ action.  \n**Behavior**\n\n* Credits are directly moved from usable → consumed.\n\
        * No intermediate hold or reservation is created.  \n**Usage**\n\nIdeal for\
        \ simple, immediate consumption scenarios where there is no need for multi-step\
        \ confirmation or concurrency control.\n\nThe response returns `ledger_operations`\
        \ (and, for compatibility, a deprecated singular `ledger_operation`), the\
        \ updated `ledger_account_balance`, the affected `grant_blocks`, and the `ledger_entries`\
        \ recorded by this operation.\n"
      operationId: capture
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                id:
                  type: string
                  deprecated: false
                  description: "Optional client-supplied identifier for this capture\
                    \ operation.  \n**Behavior**\n\n* When provided, must uniquely\
                    \ identify this operation across the entire ledger.\n* Should\
                    \ not conflict with any other operation, regardless of type.\n"
                  maxLength: 50
                  example: null
                subscription_id:
                  type: string
                  deprecated: false
                  description: |
                    A unique, immutable identifier for the [subscription](/docs/api/subscriptions/subscription-object#id) against which credit grants are tracked.
                  maxLength: 50
                  example: null
                unit_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the credit unit for which credit grants are tracked. For example, a credit unit id such as `ai_credits`.
                  maxLength: 50
                  example: null
                amount:
                  type: string
                  deprecated: false
                  description: "The number of credits to immediately consume from\
                    \ the usable balance.\nPass this value as a decimal string.  \n\
                    **Constraints**\n\nMaximum supported value: `9999999999999999999999999.9999999999`\
                    \ (up to 25 digits before the decimal and up to 10 digits after).\
                    \  \n**Behavior**\n\nCredits are directly moved from usable →\
                    \ consumed as part of this operation.  \n**Constraints**\n\n*\
                    \ Must be a positive value.\n* Evaluated against the current usable\
                    \ balance at the time of processing.  \n**Example**\n\nIf `amount\
                    \ = \"50\"`, then 50 credits are immediately deducted from the\
                    \ usable balance and recorded as consumed.\n"
                  maxLength: 36
                  example: null
                ledger_operation_timestamp:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: "Unix timestamp (in seconds) representing when the\
                    \ business operation occurred in the upstream system.  \n**Usage**\n\
                    \nUsed for period attribution, grace-period eligibility, and reporting\
                    \ accuracy.  \n**Note**\n\nLate or out-of-order submissions appear\
                    \ in arrival order, while attribution and eligibility logic rely\
                    \ on `ledger_operation_timestamp`.\n"
                  example: null
                metadata:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: "Optional opaque JSON object carrying additional business\
                    \ context  \n**Behavior**\n\n* Stored as-is and returned verbatim\
                    \ by the system.\n* Not interpreted, validated, or indexed by\
                    \ the system.\n"
                  example: null
              required:
              - amount
              - ledger_operation_timestamp
              - subscription_id
              - unit_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  ledger_operation:
                    $ref: "#/components/schemas/LedgerOperation"
                    description: |
                      **Deprecated.** Use [`ledger_operations`](#ledger_operations) instead. The single [`ledger_operation`](/docs/api/ledger_operations) resulting from this capture_authorization. Retained for backward compatibility.
                  ledger_operations:
                    type: array
                    description: |
                      The resulting [`ledger_operations`](/docs/api/ledger_operations) for this capture_authorization. Array of one or more ledger operations.
                    items:
                      $ref: "#/components/schemas/LedgerOperation"
                      description: Resource object representing ledger_operation
                    example: null
                  ledger_account_balance:
                    $ref: "#/components/schemas/LedgerAccountBalance"
                    description: |
                      Summarized real-time [`ledger_account_balance`](/docs/api/ledger_account_balances) after this capture_authorization.
                  grant_blocks:
                    type: array
                    description: |
                      The [`grant_blocks`](/docs/api/grant_blocks) affected by this operation, each reflecting its updated balances after the operation.
                    items:
                      $ref: "#/components/schemas/GrantBlock"
                      description: Resource object representing grant_block
                    example: null
                  ledger_entries:
                    type: array
                    description: |
                      The [`ledger_entries`](/docs/api/ledger_entries) recorded by this operation --- immutable, per-grant-block movements (typically `debit`, and `unhold` when releasing any unused hold) that make up this capture_authorization.
                    items:
                      $ref: "#/components/schemas/LedgerEntry"
                      description: Resource object representing ledger_entry
                    example: null
                required:
                - grant_blocks
                - ledger_account_balance
                - ledger_entries
                - ledger_operations
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /ledger_operations/allocate:
    post:
      tags:
      - ledger_operations
      summary: Allocate
      description: "The allocate operation allocates credit grants to a subscription's\
        \ provisioned balance.  \n**Behavior**\n\n* Allocates the specified `amount`\
        \ to the subscription's provisioned balance for the given `unit_id`.\n* Creates\
        \ one [grant block](/docs/api/grant_blocks) to track the credit-grant lifecycle,\
        \ including balance, holds, expiry, and rollover.\n* Creates a [ledger operation](/docs/api/ledger_operations)\
        \ of type `allocation` to record the movement of credit grants.  \n**Usage**\n\
        \nUse this operation to allocate ad-hoc credit grants to a subscription ---\
        \ for example, to reward subscribers with bonus credit grants or compensate\
        \ for service disruptions.\n\nThe response returns the created `ledger_operations`,\
        \ the updated `ledger_account_balance`, the created `grant_blocks`, and the\
        \ `ledger_entries` recorded by this operation.\n"
      operationId: allocate
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                subscription_id:
                  type: string
                  deprecated: false
                  description: |
                    A unique, immutable identifier for the [subscription](/docs/api/subscriptions/subscription-object#id) to which the allocated credit grants are applied.
                  maxLength: 50
                  example: null
                unit_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the credit unit for which credit grants are allocated. For example, a credit unit id such as `ai_credits`.
                  maxLength: 50
                  example: null
                id:
                  type: string
                  deprecated: false
                  description: "Optional client-supplied identifier for this allocate\
                    \ operation.  \n**Behavior**\n\n* When provided, must uniquely\
                    \ identify this operation across the entire ledger.\n* Should\
                    \ not conflict with any other operation, regardless of type.\n\
                    * Reusing the same value is treated as a replay of the original\
                    \ allocation rather than a conflict, so a retry does not create\
                    \ a second grant block.  \n**Constraints**\n\n* Maximum length:\
                    \ 50 characters.  \n**Default value**\n\n* When omitted, Chargebee\
                    \ generates an identifier for the operation.  \n**Usage**\n\n\
                    * Supply a value that you can reproduce, such as your own allocation\
                    \ reference, and send that same value when retrying after an unexpected\
                    \ response.\n"
                  maxLength: 50
                  example: null
                amount:
                  type: string
                  deprecated: false
                  description: "The number of credit grants to allocate as part of\
                    \ this operation.\nPass this value as a decimal string.  \n**Constraints**\n\
                    \nMaximum supported value: `9999999999999999999999999.9999999999`\
                    \ (up to 25 digits before the decimal and up to 10 digits after).\
                    \  \n**Behavior**\n\n* Must be a positive value greater than zero.\n\
                    * Allocated to the subscription's provisioned balance for the\
                    \ given `unit_id`.  \n**Example**\n\nIf `amount = \"500\"`, then\
                    \ 500 credit grants are added to the subscription's total as well\
                    \ as usable balance and recorded as a new grant block.\n"
                  maxLength: 36
                  example: null
                effective_from:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: "Optional Unix timestamp (in seconds) at which the\
                    \ allocated credit grants become usable. Sets [`effective_from`](/docs/api/grant_blocks#effective_from)\
                    \ on the grant block created by this allocation.  \n**Behavior**\n\
                    \n* When set to a future timestamp, the grant block is created\
                    \ with [`status`](/docs/api/grant_blocks#status) `scheduled` and\
                    \ its credit grants stay out of the usable balance until that\
                    \ time.\n* At `effective_from`, the grant block becomes `available`\
                    \ and its credit grants are included in the usable balance.  \n\
                    **Default value**\n\n* When omitted, the credit grants become\
                    \ usable at the time of the request.  \n**Note**\n\n`effective_from`\
                    \ is inclusive. A capture operation with a timestamp exactly equal\
                    \ to `effective_from` is eligible to consume credit grants from\
                    \ this grant block.\n"
                  example: null
                expires_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: "Unix timestamp (in seconds) at which the allocated\
                    \ credit grants expire and become unavailable for consumption.\
                    \  \n**Behavior**\n\n* Once expired, the remaining balance in\
                    \ the associated grant block moves to `expired_amount`.  \n**Constraints**\n\
                    \n* `expires_at` must be a future timestamp.\n"
                  example: null
                metadata:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: "Optional opaque JSON object carrying additional business\
                    \ context for this allocation.  \n**Behavior**\n\n* Stored as-is\
                    \ and returned verbatim by the system.\n* Not interpreted, validated,\
                    \ or indexed by the system.\n"
                  example: null
              required:
              - amount
              - expires_at
              - subscription_id
              - unit_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  ledger_account_balance:
                    $ref: "#/components/schemas/LedgerAccountBalance"
                    description: |
                      Summarized real-time [`ledger_account_balance`](/docs/api/ledger_account_balances) after this capture_authorization.
                  ledger_operations:
                    type: array
                    description: |
                      The resulting [`ledger_operations`](/docs/api/ledger_operations) resource for this allocate operation. Has `type` `allocation` and reflects the movement of credit grants into the subscription's provisioned balance.
                    items:
                      $ref: "#/components/schemas/LedgerOperation"
                      description: Resource object representing ledger_operation
                    example: null
                  grant_blocks:
                    type: array
                    description: |
                      The [`grant_blocks`](/docs/api/grant_blocks) created for this allocation, each tracking the issued credit grants, remaining balance, holds, expiry, and rollover state for the subscription.
                    items:
                      $ref: "#/components/schemas/GrantBlock"
                      description: Resource object representing grant_block
                    example: null
                  ledger_entries:
                    type: array
                    description: |
                      The [`ledger_entries`](/docs/api/ledger_entries) recorded by this operation --- immutable, per-grant-block movements of type `credit` that make up this allocation.
                    items:
                      $ref: "#/components/schemas/LedgerEntry"
                      description: Resource object representing ledger_entry
                    example: null
                required:
                - grant_blocks
                - ledger_account_balance
                - ledger_entries
                - ledger_operations
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /ledger_operations/authorize:
    post:
      tags:
      - ledger_operations
      summary: Authorize
      description: "Reserves credit grants at the time of request for later finalization\
        \ via `capture_authorization` or `release_authorization`.\n\nUse this operation\
        \ when the upstream system requires a strict balance check before finalizing\
        \ consumption. Credits are moved to a held state immediately, preventing concurrent\
        \ operations from spending the same credits.  \n**API Behavior**\n\n* Moves\
        \ credits from usable balance → held (reserved) state.\n* No consumption occurs\
        \ at this stage; only reservation.\n* Final state is determined later:\n \
        \ * `capture_authorization`: converts held credits into consumed.\n* `release_authorization`:\
        \ returns held credits to usable balance.  \n**Reserved Credits Behavior**\n\
        \n* Held credits are not consumable by other operations.\n* Held credits are\
        \ not counted as used until captured.\n* Unreleased holds are automatically\
        \ returned to usable balance upon expiry.\n\n**Use Cases**\n\n* Concurrency\
        \ control\n* Prevents multiple simultaneous operations from overspending the\
        \ same credits.\n* Ensures credits are reserved for a specific flow while\
        \ other requests see reduced availability.\n\nTwo-step workflows\nSupports\
        \ \"check now, finalize later\" flows.\n\nThe response returns `ledger_operations`\
        \ (and, for compatibility, a deprecated singular `ledger_operation`), the\
        \ updated `ledger_account_balance`, the affected `grant_blocks`, and the `ledger_entries`\
        \ recorded by this operation.\n"
      operationId: authorize
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                id:
                  type: string
                  deprecated: false
                  description: "Optional client-supplied identifier for this authorize\
                    \ operation.  \n**Behavior**\n\n* When provided, must uniquely\
                    \ identify this operation across the entire ledger.\n* Should\
                    \ not conflict with any other operation, regardless of type. \
                    \ \n**Usage**\n\n* Identifies the specific reservation of credits\
                    \ created by this request.\n* Used as the reference for subsequent\
                    \ operations:\n  * `capture_authorization`: to finalize (consume)\
                    \ the held credits.\n  * `release_authorization`: to release the\
                    \ held credits back to usable balance.\n"
                  maxLength: 50
                  example: null
                subscription_id:
                  type: string
                  deprecated: false
                  description: |
                    A unique, immutable identifier for the [subscription](/docs/api/subscriptions/subscription-object#id) against which credit grants are tracked.
                  maxLength: 50
                  example: null
                unit_id:
                  type: string
                  deprecated: false
                  description: |
                    Identifier of the credit unit for which credit grants are tracked. For example, a credit unit id such as `ai_credits`.
                  maxLength: 50
                  example: null
                amount:
                  type: string
                  deprecated: false
                  description: "The number of credit grants to reserve from the usable\
                    \ balance. While held, this amount is unavailable for other operations,\
                    \ helping prevent concurrent requests from spending the same credits.\n\
                    Pass this value as a decimal string.  \n**Constraints**\n\nMaximum\
                    \ supported value: `9999999999999999999999999.9999999999` (up\
                    \ to 25 digits before the decimal and up to 10 digits after).\
                    \  \n**Behavior**\n\n* On `authorize`, this amount is moved from\
                    \ `usable_balance` to `hold_amount`. It is not consumed yet.\n\
                    * The held amount can later be:\n  * Captured via `capture_authorization`.\n\
                    \  * Released via `release_authorization`.\n* Auto-released when\
                    \ the hold expires.  \n**Example**\n\nIf `amount = \"50\"`, the\
                    \ ledger reserves 50 credits immediately, if available. A later\
                    \ `capture_authorization` can consume all or part of that hold.\
                    \ Any unused remainder is released back to the usable balance.\n"
                  maxLength: 36
                  example: null
                ledger_operation_timestamp:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: "Unix timestamp (in seconds) representing when the\
                    \ business operation occurred in the upstream system.  \n**Usage**\n\
                    \nUsed for period attribution, grace-period eligibility, and reporting\
                    \ accuracy.  \n**Note**\n\nLate or out-of-order submissions appear\
                    \ in arrival order, while attribution and eligibility logic rely\
                    \ on `ledger_operation_timestamp`.  \n**Constraints**\n\n* The\
                    \ `ledger_operation_timestamp` must be within the last 10 minutes\
                    \ from the time of the request.\n* Grant blocks outside their\
                    \ active window (including those in the grace period) are not\
                    \ eligible for authorization and are excluded from balance checks\
                    \ for this ledger operation.\n"
                  example: null
                auto_release_timestamp:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: "Unix timestamp (in seconds) indicating when an unfinalized\
                    \ hold will be automatically released back to the usable balance.\
                    \  \n**Behavior**\n\n* Applies only to authorize operations.\n\
                    * If not explicitly provided, the system assigns a default expiry.\
                    \ Defaults to approximately 10 minutes after the authorize request\
                    \ is processed.  \n**Usage**\n\nEnsures held credits are not locked\
                    \ indefinitely by abandoned or unfinalized authorizations.  \n\
                    **Note**\n\n* By default, the value reflects what is provided\
                    \ in the request.\n* If the specified timestamp exceeds the end\
                    \ of the block's grace period, it is adjusted (clamped) to the\
                    \ grace period end and returned in the response.\n"
                  example: null
                metadata:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: "Optional opaque JSON object carrying additional business\
                    \ context  \n**Behavior**\n\n* Stored as-is and returned verbatim\
                    \ by the system.\n* Not interpreted, validated, or indexed by\
                    \ the system.\n"
                  example: null
              required:
              - amount
              - ledger_operation_timestamp
              - subscription_id
              - unit_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  ledger_operation:
                    $ref: "#/components/schemas/LedgerOperation"
                    description: |
                      **Deprecated.** Use [`ledger_operations`](#ledger_operations) instead. The single [`ledger_operation`](/docs/api/ledger_operations) resulting from this capture_authorization. Retained for backward compatibility.
                  ledger_operations:
                    type: array
                    description: |
                      The resulting [`ledger_operations`](/docs/api/ledger_operations) for this capture_authorization. Array of one or more ledger operations.
                    items:
                      $ref: "#/components/schemas/LedgerOperation"
                      description: Resource object representing ledger_operation
                    example: null
                  ledger_account_balance:
                    $ref: "#/components/schemas/LedgerAccountBalance"
                    description: |
                      Summarized real-time [`ledger_account_balance`](/docs/api/ledger_account_balances) after this capture_authorization.
                  grant_blocks:
                    type: array
                    description: |
                      The [`grant_blocks`](/docs/api/grant_blocks) affected by this operation, each reflecting its updated balances after the operation.
                    items:
                      $ref: "#/components/schemas/GrantBlock"
                      description: Resource object representing grant_block
                    example: null
                  ledger_entries:
                    type: array
                    description: |
                      The [`ledger_entries`](/docs/api/ledger_entries) recorded by this operation --- immutable, per-grant-block movements (typically `debit`, and `unhold` when releasing any unused hold) that make up this capture_authorization.
                    items:
                      $ref: "#/components/schemas/LedgerEntry"
                      description: Resource object representing ledger_entry
                    example: null
                required:
                - grant_blocks
                - ledger_account_balance
                - ledger_entries
                - ledger_operations
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /ledger_operations:
    get:
      tags:
      - ledger_operations
      summary: List ledger operations
      description: |
        Returns a list of operations meeting all the conditions specified in the filter parameters below.
      operationId: list_ledger_operations
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: "Specifies the maximum number of resources to return per page.\
          \  \n**Default and Hard Cap**\n\n* Optional parameter; if omitted, a server-defined\
          \ default is applied.\n* Values exceeding the server's maximum limit are\
          \ capped (clamped) to the allowed maximum.\n\n**Example →**\n*limit = \"\
          50\"*\n"
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: "Opaque cursor indicating the current position in the result\
          \ set for pagination.  \n**Behavior**\n\n* To fetch the next page, pass\
          \ the next_offset value returned in the previous response.\n* The value\
          \ is opaque and must not be parsed, modified, or constructed manually.\n\
          \n**Example →**\n*offset = \"\\[\"1771176208000\",\"96000000006\"\\]\"*\n"
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: subscription_id
        in: query
        description: |
          required, string filter

          Filters results by subscription identifier. This is the subscription whose operations you are listing.

          **Supported operators :** is

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

          Filters results by unit identifier. For example, a credit unit id such as `ai_credits`.

          **Supported operators :** is

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

          Filter by when the operation was recorded (`created_at`).

          **Supported operators :** after, before, on, between (per [List
          operations](/docs/api/list-ops)).

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

          Filters results by operation type.

          **Supported operators :** is, in

          **Example →**
          *type\[is\] = "capture"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            in:
              type: string
              description: |-
                * `allocation` - Allocation Operation
                * `capture` - Capture Operation
                * `authorize` - Authorization Operation
                * `release_authorization` - Release Authorization Operation
                * `capture_authorization` - Capture Authorization Operation
                * `expiry` - Expiry Operation
                * `void` - Void Operation
                * `rollover` - Rollover Operation
                * `adjustment` - Overdraft Adjustment Operation
                * `overdraft_settlement` - Settle Overdraft Amount Operation
              enum:
              - allocation
              - capture
              - authorize
              - release_authorization
              - capture_authorization
              - expiry
              - void
              - rollover
              - adjustment
              - overdraft_settlement
              pattern: "^\\[(allocation|capture|authorize|release_authorization|capture_authorization|expiry|void|rollover|adjustment|overdraft_settlement)(,(allocation|capture|authorize|release_authorization|capture_authorization|expiry|void|rollover|adjustment|overdraft_settlement))*\\\
                ]$"
              example: null
            is:
              type: string
              description: |-
                * `allocation` - Allocation Operation
                * `capture` - Capture Operation
                * `authorize` - Authorization Operation
                * `release_authorization` - Release Authorization Operation
                * `capture_authorization` - Capture Authorization Operation
                * `expiry` - Expiry Operation
                * `void` - Void Operation
                * `rollover` - Rollover Operation
                * `adjustment` - Overdraft Adjustment Operation
                * `overdraft_settlement` - Settle Overdraft Amount Operation
              enum:
              - allocation
              - capture
              - authorize
              - release_authorization
              - capture_authorization
              - expiry
              - void
              - rollover
              - adjustment
              - overdraft_settlement
              example: null
          example: null
      - name: sort_by
        in: query
        description: "optional, string filter\n\nSpecifies the field used to sort\
          \ the result set.  \n**Supported attributes**\n\n* `created_at`  \n**Sort\
          \ Order**\n\n* `asc` (ascending order)\n* `desc` (descending order)\n\n\
          **Example →**\n*sort_by\\[desc\\] = \"created_at\"*\n\nThis sorts operations\
          \ by `created_at` in descending order (most recent first).\n"
        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:
                        ledger_operation:
                          $ref: "#/components/schemas/LedgerOperation"
                          description: Resource object representing ledger_operation
                      required:
                      - ledger_operation
                      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: []
  /ledger_operations/capture_authorization:
    post:
      tags:
      - ledger_operations
      summary: Capture authorization
      description: "The capture_authorization operation finalizes a previously created\
        \ hold by converting reserved credits into consumed credits.  \n**API Behavior**\n\
        \n* Completes an earlier authorize operation.\n* Moves credits from held (reserved)\
        \ → consumed (debited).\n* Any unused portion of the hold is automatically\
        \ released back to the usable balance.\n* Once fully captured (and remainder\
        \ released, if any), the hold is considered closed.  \n**Requirement**\n\n\
        Requires the `authorization_id` (i.e., the `ledger_operation_id` of the original\
        \ authorize operation).  \n**Note**\n\n* In case of a partial capture (where\
        \ the amount held in the authorize call is greater than the amount in the\
        \ capture call), the remaining held credits are released via a separate internal\
        \ release operation.\n* This internal operation is not included in the immediate\
        \ response, but is visible via the list operations API.\n* The internal release\
        \ will have a different `ledger_operation_id` (system-generated), but will\
        \ share the same `authorization_id` as the capture operation for correlation.\n\
        \nThe response returns `ledger_operations` (and, for compatibility, a deprecated\
        \ singular `ledger_operation`), the updated `ledger_account_balance`, the\
        \ affected `grant_blocks`, and the `ledger_entries` recorded by this operation.\n"
      operationId: capture_authorization
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                authorization_id:
                  type: string
                  deprecated: false
                  description: "Identifier of the original `authorize` operation whose\
                    \ hold is being captured.  \n**Behavior**\n\n* Must reference\
                    \ a valid and active hold created via an `authorize` request.\n\
                    * Must match the `ledger_operation_id` used in the original `authorize`\
                    \ call.\n"
                  maxLength: 50
                  example: null
                id:
                  type: string
                  deprecated: false
                  description: "Optional client-supplied identifier for this capture_authorization\
                    \ operation.  \n**Behavior**\n\n* When provided, must uniquely\
                    \ identify this operation across the entire ledger.\n* Should\
                    \ not conflict with any other operation, regardless of type.\n"
                  maxLength: 50
                  example: null
                amount:
                  type: string
                  deprecated: false
                  description: "The number of credits to finalize as consumption from\
                    \ a previously authorized (held) amount.\nPass this value as a\
                    \ decimal string.  \n**Constraints**\n\nMaximum supported value:\
                    \ `9999999999999999999999999.9999999999` (up to 25 digits before\
                    \ the decimal and up to 10 digits after).  \n**Behavior**\n\n\
                    * Must be less than or equal to the current held amount for the\
                    \ specified authorization_id.\n* The specified amount is moved\
                    \ from held → consumed.  \n**Constraints**\n\nCannot exceed the\
                    \ total credits currently on hold for the authorization.  \n**Example**\n\
                    \nStep 1: Authorize (hold created): `amount = \"100\"` results\
                    \ in 100 credits moved from usable to held.\n\nStep 2: Capture\
                    \ authorization (partial consumption): `amount = \"70\"` results\
                    \ in 70 credits moved from held to consumed; remaining 30 credits\
                    \ auto-released back to usable balance (via internal release operation)\
                    \  \n**Ledger Effect Summary**\n\n* Consumed: 70\n* Released:\
                    \ 30\n* Remaining Hold: 0 (hold closed)\n"
                  maxLength: 36
                  example: null
                ledger_operation_timestamp:
                  type: integer
                  format: unix-time
                  deprecated: false
                  description: "Unix timestamp (in seconds) representing when the\
                    \ capture_authorization occurred in the upstream system.  \n**Usage**\n\
                    \nUsed for period attribution, grace-period eligibility, and reporting\
                    \ accuracy.  \n**Note**\n\nLate or out-of-order submissions appear\
                    \ in arrival order, while attribution and eligibility logic rely\
                    \ on `ledger_operation_timestamp`.\n"
                  example: null
                metadata:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  description: "Optional opaque JSON object carrying additional business\
                    \ context.  \n**Behavior**\n\n* Stored as-is and returned verbatim\
                    \ by the system.\n* Not interpreted, validated, or indexed by\
                    \ the system.\n"
                  example: null
              required:
              - amount
              - authorization_id
              - ledger_operation_timestamp
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  ledger_operation:
                    $ref: "#/components/schemas/LedgerOperation"
                    description: |
                      **Deprecated.** Use [`ledger_operations`](#ledger_operations) instead. The single [`ledger_operation`](/docs/api/ledger_operations) resulting from this capture_authorization. Retained for backward compatibility.
                  ledger_operations:
                    type: array
                    description: |
                      The resulting [`ledger_operations`](/docs/api/ledger_operations) for this capture_authorization. Array of one or more ledger operations.
                    items:
                      $ref: "#/components/schemas/LedgerOperation"
                      description: Resource object representing ledger_operation
                    example: null
                  ledger_account_balance:
                    $ref: "#/components/schemas/LedgerAccountBalance"
                    description: |
                      Summarized real-time [`ledger_account_balance`](/docs/api/ledger_account_balances) after this capture_authorization.
                  grant_blocks:
                    type: array
                    description: |
                      The [`grant_blocks`](/docs/api/grant_blocks) affected by this operation, each reflecting its updated balances after the operation.
                    items:
                      $ref: "#/components/schemas/GrantBlock"
                      description: Resource object representing grant_block
                    example: null
                  ledger_entries:
                    type: array
                    description: |
                      The [`ledger_entries`](/docs/api/ledger_entries) recorded by this operation --- immutable, per-grant-block movements (typically `debit`, and `unhold` when releasing any unused hold) that make up this capture_authorization.
                    items:
                      $ref: "#/components/schemas/LedgerEntry"
                      description: Resource object representing ledger_entry
                    example: null
                required:
                - grant_blocks
                - ledger_account_balance
                - ledger_entries
                - ledger_operations
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /ledger_operations/{ledger-operation-id}:
    get:
      tags:
      - ledger_operations
      summary: Retrieve ledger operation
      description: |
        Returns the details of a specific ledger operation by its unique identifier.
      operationId: retrieve_ledger_operation
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: ledger-operation-id
        in: path
        required: true
        deprecated: false
        $ref: "#/components/parameters/ledger-operation-id"
        style: simple
        explode: false
        schema:
          type: string
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  ledger_operation:
                    $ref: "#/components/schemas/LedgerOperation"
                    description: |
                      The [`ledger_operation`](/docs/api/ledger_operations) resource matching the given `id`, containing the full
                      details of the operation including its `type`, `amount`, balance snapshots (`provisioned_start_balance`,
                      `provisioned_end_balance`, `overdraft_start_balance`, `overdraft_end_balance`),
                      timestamps, and any associated `metadata`.
                required:
                - ledger_operation
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/500"
        "503":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/503"
      deprecated: false
      security:
      - BasicAuth: []
  /grant_blocks:
    get:
      tags:
      - grant_blocks
      summary: List grant blocks
      description: |
        Returns a list of grant blocks meeting all the conditions specified in the filter parameters below.
      operationId: list_grant_blocks
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      - name: limit
        in: query
        description: "Specifies the maximum number of resources to return per page.\
          \  \n**Default and Hard Cap**\n\n* Optional parameter; if omitted, a server-defined\
          \ default is applied.\n* Values exceeding the server's maximum limit are\
          \ capped (clamped) to the allowed maximum.\n\n**Example →**\n*limit = \"\
          50\"*\n"
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
          example: null
      - name: offset
        in: query
        description: "Opaque cursor indicating the current position in the result\
          \ set for pagination.  \n**Behavior**\n\n* To fetch the next page, pass\
          \ the next_offset value returned in the previous response.\n* The value\
          \ is opaque and must not be parsed, modified, or constructed manually.\n\
          \n**Example →**\n*offset = \"\\[\"1771176208000\",\"96000000006\"\\]\"*\n"
        required: false
        deprecated: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 1000
          example: null
      - name: subscription_id
        in: query
        description: |
          required, string filter

          Filters results by subscription identifier. This is the subscription whose grant blocks you are listing.

          **Supported operators :** is

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

          Filters results by unit identifier. For example, a credit unit id such as `ai_credits`.

          **Supported operators :** is

          **Example →**
          *unit_id\[is\] = "ai_credits"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            is:
              type: string
              minLength: 1
              example: null
          example: null
      - name: account_type
        in: query
        description: |
          optional, enum filter

          Filters results by the account the grant block belongs to: **provisioned** (plan-issued credits) or **overdraft** (consumption beyond configured grants).

          **Supported operators :** is

          **Example →**
          *account_type\[is\] = "provisioned"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          properties:
            is:
              type: string
              description: |-
                * `provisioned` - provisioned
                * `overdraft` - overdraft
              enum:
              - provisioned
              - overdraft
              example: null
          example: null
      - name: effective_from
        in: query
        description: |
          optional, timestamp(UTC) in seconds filter

          Filter by when blocks become effective (`effective_from`).

          **Supported operators :** after, before, on, between (per
          [List operations](/docs/api/list-ops)).

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

          Filter by grant expiry (`expires_at`).

          **Supported operators :** after, before, on, between (per [List
          operations](/docs/api/list-ops)).

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

          Filter by when the grant block was persisted (`created_at`).

          **Supported operators :** after, before, on, between.

          **Example →**
          *created_at\[between\] = "\[1771175750, 1771175800\]"*
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          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
      - name: sort_by
        in: query
        description: "optional, string filter\n\nSpecifies the field used to sort\
          \ the result set.  \n**Supported attributes**\n\n* `created_at`\n* `effective_from`\n\
          * `expires_at`  \n**Sort Order**\n\n* `asc` (ascending order)\n* `desc`\
          \ (descending order)\n\n**Example →**\n*sort_by\\[desc\\] = \"effective_from\"\
          *\n\nThis sorts grant blocks by `effective_from` in descending order (latest\
          \ effective time first).\n"
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
          properties:
            asc:
              type: string
              enum:
              - effective_from
              - expires_at
              - created_at
              example: null
            desc:
              type: string
              enum:
              - effective_from
              - expires_at
              - created_at
              example: null
          example: null
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        grant_block:
                          $ref: "#/components/schemas/GrantBlock"
                          description: Resource object representing grant_block
                      required:
                      - grant_block
                      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_grants:
    post:
      tags:
      - promotional_grants
      summary: Create Promotional Grant
      operationId: create_promotional_grant
      parameters:
      - name: chargebee-request-origin-device
        in: header
        description: The device from which the customer has made the request
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-device"
        style: simple
        explode: false
        schema:
          type: string
          description: The device from which the customer has made the request
          example: Android
      - name: chargebee-request-origin-user
        in: header
        description: The email address of your customer/user. Use this when the email
          address has only ASCII characters.
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: The email address of your customer/user. Use this when the
            email address has only ASCII characters.
          example: user@example.com
      - name: chargebee-request-origin-user-encoded
        in: header
        description: "The Base64-encoded email address of your customer/user. Use\
          \ this if the email address has UTF-8 characters. When this header is provided,\
          \ the header chargebee-request-origin-user is ignored."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-user-encoded"
        style: simple
        explode: false
        schema:
          type: string
          format: email
          description: "The Base64-encoded email address of your customer/user. Use\
            \ this if the email address has UTF-8 characters. When this header is\
            \ provided, the header chargebee-request-origin-user is ignored."
          example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
      - name: chargebee-request-origin-ip
        in: header
        description: The IP address of the customer where the request originated
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-request-origin-ip"
        style: simple
        explode: false
        schema:
          type: string
          description: The IP address of the customer where the request originated
          example: 192.168.1.2
          pattern: "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\\
            -]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\\
            .){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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: chargebee-business-entity-id
        in: header
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        required: false
        deprecated: false
        $ref: "#/components/parameters/chargebee-business-entity-id"
        style: simple
        explode: false
        schema:
          type: string
          description: "If the site has multiple business entities, you can use this\
            \ custom HTTP header to specify the business entity for which Chargebee\
            \ should perform the operation."
          maxLength: 50
          example: null
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                subscription_id:
                  type: string
                  deprecated: false
                  maxLength: 50
                  example: null
                unit_id:
                  type: string
                  deprecated: false
                  maxLength: 50
                  example: null
                id:
                  type: string
                  deprecated: false
                  maxLength: 50
                  example: null
                amount:
                  type: string
                  deprecated: false
                  maxLength: 36
                  example: null
                effective_from:
                  type: integer
                  format: unix-time
                  deprecated: false
                  example: null
                expires_at:
                  type: integer
                  format: unix-time
                  deprecated: false
                  example: null
                metadata:
                  type: object
                  additionalProperties: true
                  deprecated: false
                  example: null
              required:
              - amount
              - expires_at
              - subscription_id
              - unit_id
              example: null
            encoding: {}
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  ledger_operations:
                    type: array
                    items:
                      $ref: "#/components/schemas/LedgerOperation"
                      description: Resource object representing ledger_operation
                    example: null
                  grant_blocks:
                    type: array
                    items:
                      $ref: "#/components/schemas/GrantBlock"
                      description: Resource object representing grant_block
                    example: null
                required:
                - grant_blocks
                - ledger_operations
                example: null
        "400":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/400"
        "401":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/401"
        "403":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/403"
        "404":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/404"
        "405":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/405"
        "409":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/409"
        "422":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/422"
        "429":
          description: on error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/429"
        "500":
          description: on error
          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. \n* `site_not_found` - Returned\
            \ when the site is not found."
          enum:
          - resource_not_found
          - site_not_found
          example: null
      required:
      - api_error_code
      - message
      - type
      example: null
    "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: true
      enum:
      - individual
      - company
      example: null
    AccountReceivablesHandling:
      type: string
      deprecated: false
      enum:
      - no_action
      - schedule_payment_collection
      - write_off
      example: null
    AccountType:
      type: string
      deprecated: true
      enum:
      - checking
      - savings
      - business_checking
      - current
      example: null
    Action:
      type: string
      deprecated: false
      enum:
      - upsert
      - remove
      example: null
    AddUsagesReminderEvent:
      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"
            usage_reminder_info:
              $ref: "#/components/schemas/UsageReminderInfo"
          required:
          - customer
          - subscription
          - usage_reminder_info
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    AdditionalBillingLogiq:
      type: object
      properties:
        allow_price_override:
          type: boolean
          deprecated: false
          example: null
        allow_multiple_coupons:
          type: boolean
          deprecated: false
          example: null
        is_shipping_fields_enabled:
          type: boolean
          deprecated: false
          example: null
        is_reason_codes_enabled:
          type: boolean
          deprecated: false
          example: null
        is_proration_enabled:
          type: boolean
          deprecated: false
          example: null
        void_invoices_with_credit_notes:
          type: boolean
          deprecated: false
          example: null
        hide_zero_value_line_items:
          type: boolean
          deprecated: false
          example: null
        round_off_invoice_amount:
          type: boolean
          deprecated: false
          example: null
        collect_tax_registration:
          type: boolean
          deprecated: false
          example: null
        hide_chargebee_branding:
          type: boolean
          deprecated: false
          example: null
        show_update_address_and_payment_method:
          type: boolean
          deprecated: false
          example: null
        collect_invoice_on_add_or_update_payment_method:
          type: boolean
          deprecated: false
          example: null
        allow_fraud_monitor:
          type: boolean
          deprecated: false
          example: null
      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: |
            The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
            without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
            as `AZ`
            (not `US-AZ`
            ). For Tamil Nadu (India), set as `TN`
            (not `IN-TN`
            ). For British Columbia (Canada), set as `BC`
            (not `CA-BC`
            ). For Dubai (UAE), set as `DU`
            (not `AE-DU`
            ).
          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 country of the customer. Must be one of\
            \ [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
            .\n\n**Note**:\nIf you enter an invalid country code, the system will\
            \ return an error.  \n**Brexit**\n\nIf you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
            \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
            \ the Brexit configuration, then `XI` (the code for **United Kingdom -\
            \ Northern Ireland**) is available as an 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://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: |
        The invoice for a subscription in Chargebee is generated at the time of subscription renewal. Invoices can also be [generated in advance](https://www.chargebee.com/docs/advance-invoices.html) 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:

        * Set up a contract with your customers so that they can be notified of their payment schedules in advance.
        * Allow customers who make offline payments to be alerted about their upcoming dues well ahead of actual subscription renewals.
        * Prevent post-renewal unpaid usage of your services by customers.

        Advance invoices can be scheduled in two ways:

        #### Specific Dates Schedule

        Advance invoices for a subscription can be scheduled to be generated on specific [dates](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#specific_dates_schedule_date) in the future. You must specify the [number of billing cycles](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#specific_dates_schedule_terms_to_charge) to be invoiced on each date. A maximum of 5 dates can be specified.

        #### Fixed Interval Schedule

        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 ([`days_before_interval`](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#fixed_interval_schedule_days_before_renewal)) 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.

        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 `days_before_interval`, the interval begins at the next renewal. On the other hand, if the number of days remaining before the next renewal is less than `days_before_interval`, the first interval begins at the renewal following the next.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            System-generated and immutable unique Id for the `advance_invoice_schedule`
            .
          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: |
            When the `schedule_type`
            is `fixed_intervals`
            , this object gives further details of the schedule.
          properties:
            end_schedule_on:
              type: string
              deprecated: false
              description: |
                Specifies when the schedule should end.

                * after_number_of_intervals - Advance invoices are generated a `specified number of times`
                * subscription_end - Advance invoices are generated for as long as the subscription is active.
                * specific_date -
                  End the advance invoicing schedule on a `specific date`
                  .
              enum:
              - after_number_of_intervals
              - specific_date
              - subscription_end
              example: null
            number_of_occurrences:
              type: integer
              format: int32
              deprecated: false
              description: |
                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 [`remaining_billing_cycles`](/docs/api/subscriptions/subscription-object#remaining_billing_cycles)
                of the subscription. This parameter is applicable only when [`fixed_interval_schedule[end_schedule_on]`](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#fixed_interval_schedule_end_schedule_on)
                = `after_number_of_intervals`
              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: |
                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 [`fixed_interval_schedule[end_schedule_on]`](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#fixed_interval_schedule_end_schedule_on)
                = `specific_date`
                .
              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: |
                The number of billing cycles to charge for, on the date specified. Applicable only when [`schedule_type`](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#schedule_type)
                is specific_dates.
              example: null
            date:
              type: integer
              format: unix-time
              deprecated: false
              description: |
                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 [`schedule_type`](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#schedule_type)
                is `specific_dates`
                .
              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
    Alert:
      type: object
      description: "An alert defines a threshold rule for usage, spend, or credit\
        \ balance. When the configured threshold is crossed, Chargebee triggers a\
        \ webhook notification so that you can take action such as notifying the customer,\
        \ upgrading the plan, or pausing further consumption.\n\nCommon examples of\
        \ alerts include:\n\n* Notifying a customer when they have consumed 90% of\
        \ their monthly API call quota.\n* Alerting your operations team when a customer's\
        \ spend exceeds a monthly limit.\n* Warning a customer when their prepaid\
        \ credit balance drops to or below a replenishment threshold.\n\nThe alert\
        \ resource represents configuration only. To check the current runtime state\
        \ of an alert for a subscription (whether it is `within_limit` or `in_alarm`),\
        \ use the [Alert Status](/docs/api/alert_statuses) endpoints.  \n\n#### Global\
        \ vs. subscription-scoped alerts\n\nAlerts can be created at two levels:\n\
        \n* **Global alerts** apply across all relevant subscriptions. To restrict\
        \ a global alert to specific plans, use `filter_conditions` with the `plan_price_id`\
        \ field. When multiple filter conditions are provided, they are evaluated\
        \ with OR semantics: the alert applies if any condition matches.\n* **Subscription-scoped\
        \ alerts** apply to a single subscription only. Set `subscription_id` when\
        \ creating the alert. Subscription-scoped alerts cannot have `filter_conditions`.\n\
        \n**Important**\n\nA global alert and a subscription-scoped alert are mutually\
        \ exclusive in their parameters: if `subscription_id` is set, `filter_conditions`\
        \ must not be provided, and vice versa.  \n\n#### Alert types\n\nThe `type`\
        \ attribute determines what an alert measures, which input it requires, and\
        \ how the threshold is interpreted.  \nusage_exceeded  \nMonitors consumption\
        \ of a [metered feature](/docs/api/usages) for a subscription.\n\n* **Required\
        \ input:** `metered_feature_id`.\n* **Fires when:** measured usage reaches\
        \ or exceeds the configured threshold.\n* **Threshold modes:** `percentage`\
        \ (of the plan or feature quota) or `absolute` (a usage quantity).\n* **Example:**\
        \ notify a customer when they reach 90% of their monthly API-call quota.\n\
        \nUsage alerts are evaluated as [usage data](/docs/api/usage_events) is processed\
        \ for the subscription.  \nspend_exceeded  \nMonitors the total usage-based\
        \ spend accumulated from metered addons on a subscription. This is the same\
        \ overage concept surfaced by [usage charges](/docs/api/usage_charges): the\
        \ monetary overage spend corresponds to the [amount](/docs/api/usage_charges/usage-charge-object#amount)\
        \ field on the usage charge object (in major units of the currency).\n\n*\
        \ **Required input:** `currency_code` --- the ISO [currency code](/docs/api/currencies/currency-object#currency_code)\
        \ in which overage spend is tracked.\n* **Fires when:** accumulated overage\
        \ spend reaches or exceeds the configured threshold.\n* **Threshold mode:**\
        \ always `absolute` (an amount in `currency_code`).\n* **Example:** alert\
        \ the customer when their spending exceeds a 500 USD limit during the current\
        \ usage cycle.\n\nSpend alerts are evaluated as usage and overage charge data\
        \ is processed for the subscription.  \ncredit_balance_dropped  \nMonitors\
        \ the prepaid credit balance of a subscription for a specific credit unit.\
        \ See [ledger account balances](/docs/api/ledger_account_balances) for how\
        \ credit balances are tracked.\n\n* **Required input:** `unit_id` --- the\
        \ [credit unit](/docs/api/ledger_account_balances/ledger-account-balance-object#unit_id)\
        \ the alert applies to (for example, `ai_credits`).\n* **Fires when:** the\
        \ credit balance drops to or below the configured threshold. This is the opposite\
        \ direction to the `usage_exceeded` and `spend_exceeded` types, which fire\
        \ when a value rises.\n* **Threshold mode:** always `absolute` (a credit-balance\
        \ floor). `percentage` mode is not supported.\n* **Example:** warn a customer\
        \ when their remaining AI credits drop to or below 10.\n\nCredit-balance alerts\
        \ are evaluated as [ledger operations](/docs/api/ledger_operations) update\
        \ the balance.  \n\n#### Threshold modes\n\nThe `threshold` object defines\
        \ when the alert should fire. It has two fields:\n\n* `mode`: Either `percentage`\
        \ or `absolute`.\n  * `percentage`: The alert fires when the measured value\
        \ reaches the specified percentage threshold. The `value` must be between\
        \ 0 and 100 (inclusive). Supported only for `usage_exceeded` alerts.\n  *\
        \ `absolute`: The alert fires when the measured value reaches an absolute\
        \ quantity. The `value` must be \\>= 0.\n* `value`: The numeric threshold\
        \ at which the alert triggers.\n\nThe supported modes depend on the alert\
        \ `type`:\n\n* `usage_exceeded`: `percentage` or `absolute`.\n* `spend_exceeded`:\
        \ `absolute` only.\n* `credit_balance_dropped`: `absolute` only.  \n**See\
        \ also**\n\n* [Alert Statuses](/docs/api/alert_statuses) --- runtime state\
        \ of alerts per subscription.\n* [Usage Events](/docs/api/usage_events) ---\
        \ usage ingestion for `usage_exceeded` alerts.\n* [Ledger account balances](/docs/api/ledger_account_balances)\
        \ --- credit balances for `credit_balance_dropped` alerts.\n"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Uniquely identifies the alert configuration.
          maxLength: 40
          example: null
        type:
          type: string
          deprecated: false
          description: |
            The type of alert. Determines what the alert measures, which input it requires, and how the `threshold` is interpreted.

            * usage_exceeded - The alert fires when usage of the [metered feature](/docs/api/usages) (identified by `metered_feature_id`) reaches or exceeds the configured threshold. Supports both `percentage` and `absolute` threshold modes.
            * spend_exceeded - The alert fires when the total usage-based spend accumulated from metered addons reaches or exceeds the configured threshold. Only spend from usage beyond the included entitlement is counted. See [usage charges](/docs/api/usage_charges) for how overage spend is computed. The `threshold` mode is always `absolute`.
            * credit_balance_dropped - The alert fires when the [credit balance](/docs/api/ledger_account_balances) for the configured credit unit drops to or below the configured threshold. The `threshold` mode is always `absolute`.
          enum:
          - usage_exceeded
          - spend_exceeded
          - credit_balance_dropped
          example: null
        name:
          type: string
          deprecated: false
          description: |
            A human-readable name for the alert, shown in the Chargebee UI and webhook payloads. Maximum 50 characters.
          maxLength: 50
          example: null
        description:
          type: string
          deprecated: false
          description: |
            An optional description providing additional context about the alert. Maximum 65,000 characters.
          maxLength: 65000
          example: null
        metered_feature_id:
          type: string
          deprecated: false
          description: |
            Identifier of the [metered feature](/docs/api/usages) that this alert monitors. Present only for `usage_exceeded` alerts.
          maxLength: 50
          example: null
        currency_code:
          type: string
          deprecated: false
          description: |
            The ISO [currency code](/docs/api/currencies/currency-object#currency_code) in which the metered-addon overage spend is measured. Present only for `spend_exceeded` alerts.
          maxLength: 3
          example: null
        unit_id:
          type: string
          deprecated: false
          description: |
            Identifier of the credit unit that this alert monitors. Present only for `credit_balance_dropped` alerts.
          maxLength: 50
          example: null
        subscription_id:
          type: string
          deprecated: false
          description: |
            The identifier of the [subscription](/docs/api/subscriptions) this alert is scoped to. Present only for subscription-scoped alerts; `null` for global alerts.
          maxLength: 50
          example: null
        status:
          type: string
          default: enabled
          deprecated: false
          description: |
            Whether the alert is currently active. A `disabled` alert is not evaluated.

            * enabled - The alert is active and will trigger when the threshold is breached.
            * disabled - The alert is inactive and will not trigger.
          enum:
          - enabled
          - disabled
          example: null
        meta:
          type: string
          deprecated: false
          description: |
            An optional string field for storing custom metadata with the alert (for example, JSON serialized by your integration). Maximum 65,000 characters.
          maxLength: 65000
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp (UTC, in seconds) indicating when the alert was created.
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp (UTC, in seconds) indicating when the alert was last updated.
          example: null
        threshold:
          type: object
          deprecated: false
          description: |
            The threshold configuration that defines when this alert fires.
          properties:
            mode:
              type: string
              deprecated: false
              description: |
                How the threshold `value` is interpreted. `usage_exceeded` alerts support `percentage` or `absolute`. `spend_exceeded` and `credit_balance_dropped` alerts always use `absolute`.

                * percentage - The threshold `value` represents a percentage (0-100) of the plan or feature quota. Supported only for `usage_exceeded` alerts.
                * absolute - The threshold `value` represents an absolute quantity: a usage quantity for `usage_exceeded`, an overage spend amount for `spend_exceeded`, or a credit-balance floor for `credit_balance_dropped`. For `spend_exceeded`, the amount is expressed in the major units of `currency_code` (for example, dollars---not cents---for `USD`, so `500.0` means 500 USD).
              enum:
              - absolute
              - percentage
              example: null
            value:
              type: number
              format: double
              deprecated: false
              description: |
                The numeric threshold at which the alert fires. For `percentage` mode, this must be between 0 and 100 inclusive. For `absolute` mode, this must be \>= 0.
              example: null
          required:
          - mode
          - value
          example: null
        filter_conditions:
          type: array
          deprecated: false
          description: |
            An array of conditions that restrict which subscriptions a global alert applies to. Multiple conditions are evaluated with OR logic. Cannot be set when `subscription_id` is provided.
          items:
            type: object
            deprecated: false
            properties:
              field:
                type: string
                deprecated: false
                description: |
                  The subscription attribute to filter on. Currently only `plan_price_id` is supported.

                  * plan_price_id - Filters by the plan price associated with the subscription.
                enum:
                - plan_price_id
                example: null
              operator:
                type: string
                deprecated: false
                description: |
                  The comparison operator for the filter condition.

                  * not_equals - The subscription attribute must not equal the specified `value`.
                  * equals - The subscription attribute must equal the specified `value`.
                enum:
                - equals
                - not_equals
                example: null
              value:
                type: string
                deprecated: false
                description: |
                  The value to compare against, for example, a specific plan price identifier. Maximum 50 characters.
                maxLength: 50
                example: null
            required:
            - field
            - operator
            - value
            example: null
          example: null
      required:
      - created_at
      - id
      - name
      - type
      - updated_at
      example: null
    AlertStatus:
      type: object
      description: |
        An alert status represents the runtime evaluation of an [alert](/docs/api/alerts) for a specific [subscription](/docs/api/subscriptions). While the [alert](/docs/api/alerts/alert-object) resource defines the threshold rule, the alert status tells you whether a subscription is currently `within_limit` or `in_alarm` for that rule. Statuses are tracked for every alert type --- `usage_exceeded`, `spend_exceeded`, and `credit_balance_dropped`.

        Each alert status tracks:

        * `alarm_status`: The current state --- `within_limit` (the subscription is within the configured threshold) or `in_alarm` (the threshold has been breached).
        * `alarm_triggered_at`: The timestamp when the alert last entered the `in_alarm` state. This is `null` if the alert has never been triggered for this subscription.

        **Note:** Alert statuses are computed by Chargebee based on billing data and the alert configuration. They are read-only --- you cannot create or update an alert status directly. To change the threshold rule, use the [Alerts](/docs/api/alerts) API.
      properties:
        alert_id:
          type: string
          deprecated: false
          description: |
            The identifier of the [alert](/docs/api/alerts) configuration that this status corresponds to.
          maxLength: 50
          example: null
        subscription_id:
          type: string
          deprecated: false
          description: |
            The identifier of the [subscription](/docs/api/subscriptions) that this status is evaluated for.
          maxLength: 50
          example: null
        alarm_status:
          type: string
          deprecated: false
          description: |
            The current runtime state of the alert for this subscription. Indicates whether the subscription is within the configured threshold or has breached it.

            * within_limit - The subscription is within the configured threshold.
            * in_alarm - The configured threshold has been breached and the alert has been triggered for this subscription. Depending on the alert `type`, this means the measured value has reached or exceeded the threshold (`usage_exceeded`, `spend_exceeded`) or the credit balance has dropped to or below it (`credit_balance_dropped`).
          enum:
          - within_limit
          - in_alarm
          example: null
        alarm_triggered_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp (UTC, in seconds) indicating when the alert last entered the `in_alarm` state for this subscription. `null` if the alert has never been triggered.
          example: null
      required:
      - alarm_status
      - alert_id
      - subscription_id
      example: null
    AlertStatusChangedEvent:
      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:
            alert:
              $ref: "#/components/schemas/Alert"
            alert_status:
              $ref: "#/components/schemas/AlertStatus"
          required:
          - alert
          - alert_status
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      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
        amendment_contents:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                maxLength: 30
                example: null
              subscription_amendment_id:
                type: string
                deprecated: false
                maxLength: 40
                example: null
              action:
                type: string
                deprecated: false
                enum:
                - added
                - removed
                - modified
                example: null
              entity_id:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              entity_type:
                type: string
                deprecated: false
                enum:
                - customer
                - subscription
                - invoice
                - quote
                - credit_note
                - transaction
                - plan
                - addon
                - coupon
                - order
                - item_family
                - item
                - item_price
                - plan_item
                - addon_item
                - charge_item
                - plan_price
                - addon_price
                - charge_price
                - differential_price
                - attached_item
                - feature
                - subscription_entitlement
                - item_entitlement
                - business_entity
                - price_variant
                - 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
                - business_ruleset
                - alert_status
                - omnichannel_subscription_item_metric
                - price_ramp
                example: null
              field:
                type: string
                deprecated: false
                maxLength: 40
                example: null
              old_value:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              new_value:
                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
            required:
            - action
            - created_at
            - entity_type
            - field
            - id
            - subscription_amendment_id
            example: null
          example: null
      required:
      - created_at
      - effective_at
      - event_id
      - id
      - sequence_number
      - source
      - status
      - subscription_id
      - type
      example: null
    ApiKey:
      type: object
      properties:
        key_name:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        key:
          type: string
          deprecated: false
          maxLength: 250
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        status:
          type: string
          deprecated: false
          enum:
          - enabled
          - disabled
          example: null
        roles:
          type: array
          deprecated: false
          items:
            type: string
            deprecated: false
            enum:
            - full_access
            - update_access
            - read_only_access
            - read_transactional_data
            - read_product_configuration
            - publishable
            - publishable_extended
            example: null
          example: null
      required:
      - created_at
      - key_name
      example: null
    ApiVersion:
      type: string
      default: v1
      deprecated: false
      enum:
      - v1
      - v2
      example: null
    Applicability:
      type: object
      properties: {}
      example: null
    AppliedBusinessRule:
      type: object
      properties:
        handle:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        entity_type:
          type: string
          deprecated: false
          enum:
          - cpq_quote
          example: null
        entity_id:
          type: integer
          format: int64
          deprecated: false
          example: null
        entity_version:
          type: integer
          format: int32
          deprecated: false
          example: null
        rule_id:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        version:
          type: integer
          format: int32
          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
      - handle
      - modified_at
      - rule_id
      - version
      example: null
    AppliedRule:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        version:
          type: integer
          format: int32
          deprecated: false
          example: null
        name:
          type: string
          deprecated: false
          maxLength: 500
          example: null
        description:
          type: string
          deprecated: false
          maxLength: 65000
          example: null
        evaluation_result:
          type: boolean
          deprecated: false
          example: null
        error_message:
          type: string
          deprecated: false
          maxLength: 65000
          example: null
        actions:
          type: array
          deprecated: false
          items:
            example: null
          example: null
      required:
      - id
      example: null
    ApplyOn:
      type: string
      deprecated: false
      enum:
      - invoice_amount
      - specific_item_price
      example: null
    ApplyRule:
      type: object
      properties:
        evaluate:
          type: boolean
          deprecated: false
          example: null
        rule_id:
          type: string
          deprecated: false
          example: null
        ruleset_id:
          type: string
          deprecated: false
          example: null
        skip_failed_rules:
          type: boolean
          deprecated: false
          example: null
        structured_expression:
          type: object
          additionalProperties: true
          deprecated: false
          example: null
        context:
          type: object
          additionalProperties: true
          deprecated: false
          example: null
        rules:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              version:
                type: integer
                format: int32
                deprecated: false
                example: null
              name:
                type: string
                deprecated: false
                maxLength: 500
                example: null
              description:
                type: string
                deprecated: false
                maxLength: 65000
                example: null
              evaluation_result:
                type: boolean
                deprecated: false
                example: null
              error_message:
                type: string
                deprecated: false
                maxLength: 65000
                example: null
              actions:
                type: array
                deprecated: false
                items:
                  example: null
                example: null
            required:
            - id
            example: null
          example: null
      example: null
    Approval:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        headline:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        approval_type:
          type: string
          deprecated: false
          enum:
          - item_price_point
          - critical_actions
          - quotes
          example: null
        action_type:
          type: string
          deprecated: false
          maxLength: 40
          example: null
        version_number:
          type: integer
          format: int64
          deprecated: false
          example: null
        approval_config_rule_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        status:
          type: string
          deprecated: false
          enum:
          - yet_to_start
          - in_progress
          - approved
          - rejected
          - cancelled
          - override_approved
          - override_rejected
          - override_cancelled
          example: null
        requester:
          type: string
          deprecated: false
          maxLength: 150
          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
      - approval_type
      - created_at
      - id
      - modified_at
      - status
      example: null
    ApprovalConditionInfo:
      type: object
      properties:
        operand:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        operator:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        value:
          type: string
          deprecated: false
          maxLength: 65000
          example: null
      required:
      - operand
      - operator
      example: null
    ApprovalEstimate:
      type: object
      properties:
        approval_required:
          type: boolean
          deprecated: false
          example: null
      required:
      - approval_required
      example: null
    ApprovalPreviewInfo:
      type: object
      properties:
        rule_name:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        version:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        rule_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        stages:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              name:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              approver_policy:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              users:
                type: array
                deprecated: false
                items:
                  type: object
                  deprecated: false
                  properties:
                    name:
                      type: string
                      deprecated: false
                      maxLength: 50
                      example: null
                    email:
                      type: string
                      deprecated: false
                      maxLength: 100
                      example: null
                  required:
                  - email
                  - name
                  example: null
                example: null
            required:
            - approver_policy
            - name
            example: null
          example: null
        conditions:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              operand:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              operator:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              value:
                type: string
                deprecated: false
                maxLength: 65000
                example: null
            required:
            - operand
            - operator
            example: null
          example: null
      required:
      - rule_id
      - rule_name
      - version
      example: null
    ApprovalStageInfo:
      type: object
      properties:
        name:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        approver_policy:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        users:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              name:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              email:
                type: string
                deprecated: false
                maxLength: 100
                example: null
            required:
            - email
            - name
            example: null
          example: null
      required:
      - approver_policy
      - name
      example: null
    ApprovalUserInfo:
      type: object
      properties:
        name:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        email:
          type: string
          deprecated: false
          maxLength: 100
          example: null
      required:
      - email
      - name
      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
    AsyncResponse:
      type: object
      description: "**Note:** The asynchronous API is only enabled for selected customers.\
        \ To enable it for your site, [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\
        \nThe Chargebee asynchronous API allows selected API operations to be executed\
        \ in the background. Instead of waiting for the operation to complete within\
        \ the same HTTP request, the API immediately acknowledges the request and\
        \ processes it asynchronously.\n\nYour application sends the same API request\
        \ it would use for a synchronous call, but with [special headers](#required-headers).\
        \ Chargebee responds immediately with HTTP `202 Accepted` and an empty response\
        \ body, meaning the work has been accepted and will run in the background.\n\
        \nWhen processing finishes (success or failure), Chargebee delivers the outcome\
        \ to the callback URL provided in the request header. The callback payload\
        \ contains the `async_response` object described below.\n\nBoth synchronous\
        \ and asynchronous requests use the same API endpoints and request payloads.\
        \ The distinction is defined solely by the request headers.\n\n### Required\
        \ headers\n\n|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n\
        | **Header**                       | **Purpose**                         \
        \                                                                        \
        \                                                                        \
        \ |\n| **Prefer: respond-async**        | **Required.** Tells Chargebee to\
        \ process the request asynchronously and return `202 Accepted`.          \
        \                                                                        \
        \     |\n| **chargebee-request-id**         | **Required.** Your unique id\
        \ for this async api (see [chargebee-request-id](#chargebee-request-id)).\
        \                                                                        \
        \         |\n| **chargebee-async-callback-url** | **Required.** The callback\
        \ URL where Chargebee will POST the result. Must be in the format: `https://username:password@example.com`\
        \ (see [async-api-callback](#async-api-callback)). |\n\n### Async API callback\n\
        \nYou must provide a callback URL in the `chargebee-async-callback-url` header\
        \ for every async API request. Chargebee delivers the outcome (success or\
        \ failure) to this URL when asynchronous processing completes. Ensure the\
        \ provided URL is a stable HTTPS endpoint.\n\nThe response is a list envelope:\n\
        \n```json\n{\n  \"list\": [\n    {\n      \"async_response\": {\n        \"\
        api_version\": \"v2\",\n        \"created_at\": 1780464441,\n        \"completed_at\"\
        : 1780464442,\n        \"status\": \"success\",\n        \"request\": {\n\
        \          \"id\": \"7c9e2f4a-8b1d-4e6f-9a0c-merchant-generated-uuid\",\n\
        \          \"resource\": \"invoice\",\n          \"operation_type\": \"void_invoice\"\
        ,\n          \"method\": \"POST\",\n          \"uri\": \"/api/v2/invoices/inv_123/void\"\
        \n        },\n        \"result\": {\n          \"invoice\": {\n          \
        \  \"id\": \"inv_123\",\n            \"status\": \"voided\",\n           \
        \ \"object\": \"invoice\"\n          }\n        }\n      }\n    }\n  ]\n}\n\
        ```\n\nWhen `status` is `failed`, `result` is omitted and `error_detail` is\
        \ included instead.\n\n### Chargebee Request Id\n\nThis header is the primary\
        \ key for your async job.  \n\n|-------------------------|---------------------------------------------------------------------------------------------------------------------|\n\
        | **Topic**               | **Detail**                                   \
        \                                                                       |\n\
        | Purpose                 | Uniquely identifies one async submission so you\
        \ can match the eventual callback to the originating call.            |\n\
        | Required                | Omitting it or sending a blank value results in\
        \ an invalid request error.                                           |\n\
        | Max length              | 100 characters.                              \
        \                                                                       |\n\
        | Uniqueness              | Must be unique. Reuse is allowed after two days.\
        \                                                                    |\n|\
        \ Recommended format      | A UUID (36 characters) or another opaque string\
        \ within the length limit. Avoid personally identifiable information. |\n\
        | Correlation in callback | The callback includes the same value as `request.id`\
        \ inside the `async_response` object.                            |\n\n###\
        \ Example request\n\n```bash\ncurl https://{site}.chargebee.com/api/v2/invoices/inv_123/void\
        \ \\\n  -u {api_key}: \\\n  -X POST \\\n  -H \"Prefer: respond-async\" \\\n\
        \  -H \"chargebee-request-id: 7c9e2f4a-8b1d-4e6f-9a0c-merchant-generated-uuid\"\
        \ \\\n  -H \"chargebee-async-callback-url: https://username:password@example.com\"\
        \ \\\n  -d comment=\"Shipped in error\"\n```\n\n### Immediate HTTP response\n\
        \n* **`202 Accepted`** --- The request is queued. The response body is empty;\
        \ treat acceptance as successful handoff. Final success or failure is delivered\
        \ only via your async callback.\n* **`4xx`** --- Validation, authentication,\
        \ or other immediate errors are returned synchronously (no async queueing).\n\
        \n### Integration checklist\n\n* Send `Prefer: respond-async` and a unique\
        \ `chargebee-request-id` (≤ 100 chars) on every async call.\n* Handle `202`\
        \ --- do not expect the final resource in the immediate HTTP response.\n*\
        \ Pass the `chargebee-async-callback-url` header with your callback URL on\
        \ every async call.\n* You can reuse the `chargebee-request-id` after two\
        \ days.\n* Async submissions are deduplicated using the unique `chargebee-request-id`,\
        \ not [idempotency keys](/docs/api/idempotency). If you send a `chargebee-idempotency-key`,\
        \ it is echoed back in `request.idempotency_key` as metadata but is not used\
        \ for deduplication.\n"
      properties:
        api_version:
          type: string
          deprecated: false
          description: |
            The Chargebee API version used for the original request. For example, `v2`.
          maxLength: 10
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp at which the async request was accepted and queued by Chargebee.
          example: null
        completed_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp at which the async operation finished processing (success or failure).
          example: null
        status:
          type: string
          deprecated: false
          description: |
            Current completion status of the async operation.

            * failed - The operation failed after being accepted for async processing. The `error_detail` object contains failure information.
            * success - The operation completed successfully. The `result` object contains the API response.
          enum:
          - success
          - failed
          example: null
        result:
          type: object
          additionalProperties: true
          deprecated: false
          description: |
            Returned only when `status` is `success`. Contains the same response structure that the synchronous version of the API operation would have returned. For example, if the original request created a credit note, `result` contains a `credit_note` object.
          example: null
        request:
          type: object
          deprecated: false
          description: |
            Object containing metadata about the original API request that was submitted asynchronously.
          properties:
            id:
              type: string
              deprecated: false
              description: |
                The unique identifier you provided in the `chargebee-request-id` header of the original async request.
              maxLength: 100
              example: null
            resource:
              type: string
              deprecated: false
              description: |
                The API resource targeted by the original request. For example, `credit_note` or `invoice`.
              maxLength: 100
              example: null
            operation_type:
              type: string
              deprecated: false
              description: |
                The operation type of the original request. For example, `create_credit_note` or `void_invoice`.
              maxLength: 100
              example: null
            method:
              type: string
              deprecated: false
              description: |
                The HTTP method of the original request. For example, `POST`.
              maxLength: 10
              example: null
            uri:
              type: string
              deprecated: false
              description: |
                The request URI of the original API call. For example, `/api/v2/credit_notes`.
              maxLength: 512
              example: null
            idempotency_key:
              type: string
              deprecated: false
              description: |
                The `chargebee-idempotency-key` sent in the original request, if any. This value is echoed back as metadata only; async submissions are deduplicated using the unique `chargebee-request-id`, not the idempotency key.
              maxLength: 250
              example: null
          required:
          - id
          example: null
        error_detail:
          type: object
          deprecated: false
          description: |
            Returned when `status` is `failed`. Contains information about why the operation failed.
          properties:
            message:
              type: string
              deprecated: false
              description: |
                A human-readable description of the error.
              maxLength: 500
              example: null
            type:
              type: string
              deprecated: false
              description: |
                The category of the error. For example, `invalid_request`.
              maxLength: 100
              example: null
            api_error_code:
              type: string
              deprecated: false
              description: |
                A Chargebee-defined [error code](/docs/api/error-handling) identifying the specific error. For example, `resource_not_found`.
              maxLength: 100
              example: null
            error_code:
              type: string
              deprecated: false
              description: |
                An additional error code associated with the failure, when available.
              maxLength: 100
              example: null
            error_msg:
              type: string
              deprecated: false
              description: |
                An additional error message associated with the failure, when available.
              maxLength: 250
              example: null
            http_status_code:
              type: string
              deprecated: false
              description: |
                The HTTP status code that the synchronous version of the API operation would have returned for this failure.
              maxLength: 100
              example: null
          example: null
      required:
      - status
      example: null
    AsyncResponseList:
      type: object
      properties:
        list:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              api_version:
                type: string
                deprecated: false
                maxLength: 10
                example: null
              created_at:
                type: integer
                format: unix-time
                deprecated: false
                example: null
              completed_at:
                type: integer
                format: unix-time
                deprecated: false
                example: null
              status:
                type: string
                deprecated: false
                enum:
                - success
                - failed
                example: null
              request:
                type: object
                deprecated: false
                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
                  method:
                    type: string
                    deprecated: false
                    maxLength: 10
                    example: null
                  uri:
                    type: string
                    deprecated: false
                    maxLength: 512
                    example: null
                  idempotency_key:
                    type: string
                    deprecated: false
                    maxLength: 250
                    example: null
                required:
                - id
                example: null
              error_detail:
                type: object
                deprecated: false
                properties:
                  message:
                    type: string
                    deprecated: false
                    maxLength: 500
                    example: null
                  type:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  api_error_code:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  error_code:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  error_msg:
                    type: string
                    deprecated: false
                    maxLength: 250
                    example: null
                  http_status_code:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                example: null
              result:
                type: object
                additionalProperties: true
                deprecated: false
                example: null
            required:
            - status
            example: null
          example: null
      example: null
    AttachedItem:
      type: object
      description: |
        Addon-item and charge-item prices are purchased with plan-item prices in subscriptions. You can automate this process by configuring certain addons and charges as "attached" to certain plans. This is done at the "item" level. In other words, addon- and charge-items can be attached to plan-items.

        Once the attachment is defined, while creating or updating a subscription, the addon- or charge-item prices are selected automatically based on the plan-item price selected . Let's look at the details:

        ### Addons

        Addons can be attached to plans as `recommended`, `mandatory` or `optional`.

        * When an addon is attached as `recommended` for a plan, the addon is suggested to be applied to subscriptions for the plan in [Checkout](https://www.chargebee.com/docs/2.0/configure-inapp.html#fundamental-settings_recommending-addons-in-checkout) and [Self-Serve Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html#allow-change-subscription). Alternatively, if you build your own payment pages or have a sales team, you can suggest recommended addons to your customers or salespeople on your website or CRM respectively
        * When an addon is attached as `mandatory` for a plan, the addon gets applied to subscriptions for the plan compulsorily, unless [removed explicitly](/docs/api/subscriptions). If you do not pass an item price for a mandatory addon when including the plan in a subscription, an addon-item price is automatically applied as explained below.
        * Attaching an addon as `optional` neither marks it as recommended or mandatory but allows you a way to set a `quantity` and `billing_cycles` for the addon, for when it is applied to subscriptions with the plan.

        How auto-selection of the addon-item price works
        ------------------------------------------------

        Once an addon has been attached as mandatory, the addon-item price to be applied to the plan-item price is selected based on the following rule: The addon-item price with the same currency as that of the plan-item price and the longest compatible period is selected.

        Here's an example:

        Consider a plan **Standard Cloud Storage** has an addon **Extra Storage** attached to it. Note that each of the two are items. Now consider that they have item prices with the following periods and currencies:

        **Item price for "Standard Cloud Storage" plan-item:**

        * Standard Cloud Storage, 3 years, AUD.

        **Item prices for "Extra Storage" addon-item:**

        * Extra Storage, 1 year, EUR.
        * Extra Storage, 1 year, USD.
        * Extra Storage, 1 year, AUD.
        * Extra Storage, 18 months, AUD.
        * Extra Storage, 2 years, AUD.
        * Extra Storage, 30 months, AUD.

        For the plan-item price (Standard Cloud Storage, 3 years, AUD), the addon-item prices with matching currencies are the last 4 from the above list:

        * Extra Storage, 1 year, AUD.
        * Extra Storage, 18 months, AUD.
        * Extra Storage, 2 years, AUD.
        * Extra Storage, 30 months, AUD.

        From among them, the last two have periods that are incompatible with the plan-item price period of 3 years. From the remaining 2 addon-item prices, the one with the longest period is of 18 months. So, "Extra Storage, 18 months, AUD" is selected for mandatory application to the plan item price.

        ### Charges

        Charges can also be attached to plans. When doing so, you specify [the event](/docs/api/attached_items/attached_item-object#charge_on_event) at which the charge is to be applied to the subscription. For some events that can occur multiple times in a subscription lifetime, you can also set whether to apply the charge each time the event occurs or just once.

        There may be multiple item prices for a given attached charge. The item price that matches the currency of the plan-item price is automatically selected for application.

        Here's an example:

        Consider a plan **Standard Cloud Storage** has a charge named **Implementation Fee** attached to it. Now consider their item prices below, with the following periods and currencies:

        **Item price for "Standard Cloud Storage" plan-item:**

        * Standard Cloud Storage, 3 years, AUD.

        **Item prices for "Implementation Fee" charge-item:**

        * Implementation Fee, USD.
        * Implementation Fee, AUD.
        * Implementation Fee, EUR.

        From among the charge-item prices above, the one compatible with the plan-item price is "Implementation Fee, AUD" since it has the same currency as the plan-item price.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            The unique id for the attached item. Set to a random, immutable value automatically when the attached item is created.
          maxLength: 100
          example: null
        parent_item_id:
          type: string
          deprecated: false
          description: |
            The `id`
            of the plan-item to which the item is attached.
          maxLength: 100
          example: null
        item_id:
          type: string
          deprecated: false
          description: |
            The id of the item being attached.
          maxLength: 100
          example: null
        type:
          type: string
          deprecated: false
          description: |
            The type of attachment for the addon. Only applicable for addon-items.

            * recommended -
              The addon is recommended to go with the plan-item when using [Checkout](https://www.chargebee.com/docs/2.0/configure-inapp.html#fundamental-settings_recommending-addons-in-checkout)
              or [Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html#allow-change-subscription)
              .
            * optional -
              The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a `quantity`
              and `billing_cycles`
              for the addon, for when it is applied to subscriptions with the plan.
            * mandatory -
              The addon is attached automatically to the subscription for the plan-item unless [explicitly removed](/docs/api/subscriptions)
              via API.
          enum:
          - recommended
          - mandatory
          - optional
          example: null
        status:
          type: string
          deprecated: false
          description: |
            The item state.

            * active - New subscriptions can be created with the item.
            * deleted - No subscriptions allowed for the item.
            * archived - No new subscriptions allowed for the item.
          enum:
          - active
          - archived
          - deleted
          example: null
        quantity:
          type: integer
          format: int32
          deprecated: false
          description: |
            The default quantity of the addon to be attached when the quantity is not specified while [creating](/docs/api/subscriptions/create-subscription-for-items)
            /[updating](/docs/api/subscriptions/update-subscription-for-items)
            the subscription.
          minimum: 1
          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/getting-started)
            is enabled.
          maxLength: 33
          example: null
        billing_cycles:
          type: integer
          format: int32
          deprecated: false
          description: |
            The number of subscription billing cycles for which this item is attached when applied to a subscription. Applicable only for items of type addon. Requires [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)
            to be enabled for the site.

            The value set explicitly for `billing_cycles`
            while [applying the addon to a subscription](/docs/api/subscriptions/subscription-object#subscription_items)
            takes precedence over this attribute. This attribute, in turn, has a higher precedence than [the value set for the addon-item price](/docs/api/item_prices)
            .
          minimum: 1
          example: null
        charge_on_event:
          type: string
          deprecated: false
          description: |
            Indicates when the item is charged. This attribute only applies to charge-items.

            * contract_termination -
              when a contract term is [terminated](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option)
              .
            * subscription_creation - the time of creation of the subscription.
            * subscription_trial_start - the time when the trial period of the subscription begins.
            * on_demand - Item can be charged on demand
            * plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
            * subscription_activation -
              the moment a subscription enters an `active`
              or `non-renewing`
              state. Also includes reactivations of canceled subscriptions.
          enum:
          - subscription_creation
          - subscription_trial_start
          - plan_activation
          - subscription_activation
          - contract_termination
          - on_demand
          example: null
        charge_once:
          type: boolean
          deprecated: false
          description: |
            Indicates if the charge-item is to be charged only once or each time the `charge_on_event`
            occurs. This attribute only applies to charge-items.
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The time at which this attached item was created.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            Version number of this resource. The `resource_version`
            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.
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The time at which this attached item was last updated.
          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
        business_entity_id:
          type: string
          deprecated: false
          description: |
            The unique ID of the
            [business entity](/docs/api/getting-started)
            of this subscription. This is applicable only when multiple business entities have been created for the site. The value of this attribute indicates that the resource is specific to the given business entity.
          maxLength: 50
          example: null
        deleted:
          type: boolean
          deprecated: false
          description: |
            Indicates whether the attached item has been deleted or not.
          example: null
      required:
      - created_at
      - deleted
      - id
      - item_id
      - parent_item_id
      - type
      example: null
    AttachedItemCreatedEvent:
      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:
            attached_item:
              $ref: "#/components/schemas/AttachedItem"
          required:
          - attached_item
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    AttachedItemDeletedEvent:
      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:
            attached_item:
              $ref: "#/components/schemas/AttachedItem"
          required:
          - attached_item
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    AttachedItemUpdatedEvent:
      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:
            attached_item:
              $ref: "#/components/schemas/AttachedItem"
          required:
          - attached_item
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    Attribute:
      type: object
      properties:
        name:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        value:
          type: string
          deprecated: false
          maxLength: 100
          example: null
      required:
      - name
      - value
      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
    BillingMetricBreakdown:
      type: object
      properties:
        line_item_code:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        line_item_type:
          type: string
          deprecated: false
          enum:
          - plan
          - addon
          - charge
          - discount
          - tax
          example: null
        date_from:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        date_to:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        total_amount:
          type: integer
          format: int64
          default: 0
          deprecated: false
          example: null
        line_item_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        billing_doc_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        billing_doc_type:
          type: string
          deprecated: false
          enum:
          - invoice
          - credit_note
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        subscription_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        customer_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        lineage_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        version:
          type: integer
          format: int32
          deprecated: false
          example: null
        occurred_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        allocated_amount:
          type: integer
          format: int64
          deprecated: false
          example: null
        credit_note_reason_code:
          type: string
          deprecated: false
          maxLength: 100
          example: null
      required:
      - billing_doc_type
      - created_at
      - date_from
      - date_to
      - line_item_code
      - line_item_id
      - line_item_type
      - total_amount
      - updated_at
      example: null
    BillingMetricLine:
      type: object
      properties:
        lineage_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        customer_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        contract_term_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        item_price_id:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        quantity_per_billing_cycle:
          type: string
          deprecated: false
          maxLength: 39
          example: null
        unit_price_per_billing_cycle:
          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
          - not_applicable
          example: null
        effective_from:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        effective_to:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        trial_end:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        total_contract_value_before_tax:
          type: integer
          format: int64
          default: 0
          deprecated: false
          minimum: 0
          example: null
        total_tax_amount:
          type: integer
          format: int64
          default: 0
          deprecated: false
          minimum: 0
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        subscription_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        version:
          type: integer
          format: int32
          deprecated: false
          example: null
        occurred_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        contract_created_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        contract_start:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        contract_end:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        currency:
          type: string
          deprecated: false
          maxLength: 3
          example: null
        discounts:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              code:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              allocated_amount:
                type: integer
                format: int64
                default: 0
                deprecated: false
                minimum: 0
                example: null
              type:
                type: string
                deprecated: false
                enum:
                - discount
                - coupon
                example: null
              apply_on:
                type: string
                deprecated: false
                enum:
                - invoice_amount
                - specific_item_price
                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:
            - allocated_amount
            example: null
          example: null
      required:
      - created_at
      - customer_id
      - effective_from
      - effective_to
      - item_price_id
      - lineage_id
      - quantity_per_billing_cycle
      - total_contract_value_before_tax
      - total_tax_amount
      - unit_price_per_billing_cycle
      - updated_at
      example: null
    BillingPeriodUnit:
      type: string
      deprecated: false
      enum:
      - day
      - week
      - month
      - year
      example: null
    BillingStartOption:
      type: string
      default: on_specific_date
      deprecated: false
      enum:
      - immediately
      - on_specific_date
      example: null
    BillingTiming:
      type: string
      deprecated: true
      enum:
      - advanced
      - arrears
      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
    BusinessEntity:
      type: object
      description: "The `business_entity` resource represents a business unit or brand\
        \ under your organization. Key resources in Chargebee Billing (such as [customer](/docs/api/customers),\
        \ [subscriptions](/docs/api/subscriptions), [invoices](/docs/api/invoices),\
        \ and [transactions](/docs/api/transactions)) along with the associated site\
        \ configurations, fall under a [business entity](https://www.chargebee.com/docs/2.0/mbe.html).\
        \ Each Chargebee Billing [site](https://www.chargebee.com/docs/2.0/sites-intro.html)\
        \ has one business entity by default. You may create multiple business entities\
        \ in the following scenarios:\n\n* **Multiple Business Units**: You may be\
        \ running your business under different regional units with different \"invoice-from\"\
        \ addresses. This is usually done to manage taxation and bookkeeping. In such\
        \ a case, you may create a business entity for each business unit.\n* **Multiple\
        \ Brands**: You may have multiple brands within your business, such as those\
        \ acquired via mergers and acquisitions. You may create a business entity\
        \ for each brand.\n\nCreating multiple business entities lets you separate\
        \ configuration and data for your business units or brands so that you can\
        \ manage their billing and revenue operations independently.  \n**See also**\n\
        \n[More information](https://www.chargebee.com/docs/2.0/mbe.html) on business\
        \ entities and the configuration options available.  \nSpecifying business\
        \ entity in API operations  \nAll API operations in Chargebee have site [context](/docs/api/business_entities).\
        \ Context restrictions cannot be assigned to [API keys](https://www.chargebee.com/docs/2.0/api_keys.html).\
        \ However, if your site has multiple business entities, you can specify the\
        \ business entity [context](/docs/api/business_entities) for an API call by\
        \ passing a [custom HTTP request header](/docs/api/advanced-features).  \n\
        API behavior based on business entity specified  \nThe table below explains\
        \ how Chargebee responds to various API calls depending on whether the business\
        \ entity ID is specified as part of the API call.  \n**Note**\n\nSome of the\
        \ words used here are defined in the [Terminology section](/docs/api/business_entities).\
        \  \n\n|         **Operation/Type of operation**          |              \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \  **Behavior**                                                          \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                              |                                         \
        \                                                                        \
        \                                                                        \
        \                                           **Examples**                 \
        \                                                                        \
        \                                                                        \
        \                                                                   |\n|--------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n\
        | Any operation that creates a `customer` resource | * If `business_entity_id`\
        \ **is provided** , the `customer` resource is created and linked to it. *\
        \ If `business_entity_id` **is not provided** , the `customer` resource is\
        \ created under the [default business entity](/docs/api/business_entities)\
        \ of the site.                                                           \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \               | * [Create a customer](/docs/api/customers/create-a-customer)\
        \ * When [Create a checkout for charge items and quick charge](/docs/api/hosted_pages/checkout-charge-items-and-one-time-charges)s\
        \ or [Create checkout for a new subscription](/docs/api/hosted_pages/create-checkout-for-a-new-subscription)\
        \ is called, providing a value for `customer[id]` that is not already present\
        \ in the site. This creates a new `customer` resource.                   \
        \                       |\n| Create a resource other than `customer`     \
        \     | * If `business_entity_id` **is provided** , and it is the same as\
        \ that [linked](/docs/api/business_entities) to the [target resource](/docs/api/business_entities):\
        \ the resource is created and linked to the business entity provided. * If\
        \ `business_entity_id` **is provided** , and it is not the same as that linked\
        \ to the target resource, a `404 Not Found` response is sent because the resource\
        \ cannot be found in the [context](/docs/api/business_entities) of the business\
        \ entity specified. * If `business_entity_id` **is not provided**, the resource\
        \ is created and linked to the business entity of the target resource. | *\
        \ [Create a subscription](/docs/api/subscriptions/create-subscription-for-items):\
        \ the target resource is a `customer`. * [Create a comment](/docs/api/comments/create-a-comment):\
        \ the target resource is specified in the value provided for `entity_type`.\
        \ * [Create an invoice for items and one-time charges](/docs/api/invoices/create-invoice-for-items-and-one-time-charges):\
        \ depending on the ID specified, the target resource is either a `customer`\
        \ or a `subscription`. |\n| Update/delete a resource                     \
        \    | * If `business_entity_id` **is provided** , and it is the same as that\
        \ [linked](/docs/api/business_entities) to the resource, the operation proceeds\
        \ successfully. * If `business_entity_id` **is provided** , and it is not\
        \ the same as that [linked](/docs/api/business_entities) to the resource,\
        \ a `404 Not Found` response is sent because the resource cannot be found\
        \ in the [context](/docs/api/business_entities) of the business entity specified.\
        \ * If `business_entity_id` **is not provided**, the operation proceeds successfully.\
        \                                                                        \
        \                   | * [Update a customer](/docs/api/customers/update-a-customer)\
        \ * [Update a subscription](/docs/api/subscriptions/update-subscription-for-items)\
        \ * [Update a card payment source](/docs/api/payment_sources/update-a-card-payment-source)\
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                     |\n| List resources                                \
        \   | * If `business_entity_id` **is provided,** then only those resources\
        \ linked to the business entity are returned since the [context](/docs/api/business_entities)\
        \ of the operation is now restricted to the business entity specified. * If\
        \ `business_entity_id` **is not provided**, then all resources in the site\
        \ are returned.                                                          \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                        | * [List customers](/docs/api/customers/list-customers)\
        \ * [List payment sources](/docs/api/payment_sources/list-payment-sources)\
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                    |\n| Retreive a resource\
        \                              | * If `business_entity_id` **is provided**\
        \ , and it is the same as that [linked](/docs/api/business_entities) to the\
        \ resource, the resource is retrieved successfully. * If `business_entity_id`\
        \ **is provided** , and it is not the same as that [linked](/docs/api/business_entities)\
        \ to the resource, a `404 Not Found` response is sent because the resource\
        \ cannot be found in the [context](/docs/api/business_entities) of the business\
        \ entity specified. * If `business_entity_id` **is not provided**, the resource\
        \ is retrieved successfully.                                             \
        \                                        | * [Retrieve a customer](/docs/api/customers/retrieve-a-customer)\
        \ * [Retrieve a comment](/docs/api/comments/retrieve-a-comment)          \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                           |\n\nTerminology  \nThis section\
        \ defines some useful terms for describing how business entities work.\n\n\
        #### Linked business entity {#mbe-terms-content}\n\nAny resource is always\
        \ associated with precisely one and only one business entity. We call it the\
        \ linked business entity of the resource, or simply, the business entity of\
        \ the resource.\n\n#### Default business entity\n\nWhen `customer` resource\
        \ is created and no business entity is specified, it is linked to the business\
        \ entity designated as the default business entity of the site. A site always\
        \ has a default business entity. Please choose the first business entity details\
        \ carefully, as it can't be changed later, and this will be your default entity\
        \ when no business entity is specified.\n\n#### Context of an operation\n\n\
        Any site has data in it. This includes all the various resources such as customers,\
        \ subscriptions, invoices, comments, and so on. The \"context\" of an API\
        \ operation is the subset of site data it has access to. An API operation\
        \ can only read or write data within its context. By default, an API operation\
        \ has \"site context\", which means it has access to the entire site's data.\
        \ However, when a business entity is [specified](/docs/api/business_entities)\
        \ in an API operation, it has \"business entity context\", which means that\
        \ the operation only has access to the data linked to the business entity.\
        \  \n**Example**\n\nConsider the [List customers API](/docs/api/customers/list-customers).\
        \ When you call the API without specifying a business entity, its context\
        \ is that of the site and therefore returns customer resources for the entire\
        \ site. However, when you specify a business entity, the context is only that\
        \ of the business entity, and therefore the customer resources of only the\
        \ selected business entity are returned.\n\nLet's look at the [Create checkout\
        \ for a new subscription API](/docs/api/hosted_pages/create-checkout-for-a-new-subscription).\
        \ Say you're calling this API and providing the `customer[id]` parameter.\
        \ When no business entity is specified, the operation has *site context* and\
        \ therefore looks up the ID among all the customer resources in the site.\
        \ However, when a business entity is provided, the operation has *business\
        \ entity context* and looks up the ID only among the customers linked to that\
        \ business entity.\n\n#### Target resource\n\nWhile creating an API resource\
        \ other than a `customer`, you specify a target resource under which it should\
        \ be created. For example:\n\n* While [creating an `invoice` resource for\
        \ a one-time charge](/docs/api/invoices/create-invoice-for-items-and-one-time-charges),\
        \ you must specify either the `customer` or the `subscription` resource to\
        \ which it belongs. The `customer` or `subscription` resource, in this case,\
        \ is the target resource of the `invoice`.\n* While [creating a `subscription`](/docs/api/subscriptions/create-subscription-for-items),\
        \ the target resource of a `subscription` resource is always a `customer`\
        \ resource.\n* While [creating a `quote` resource of `type` `change_subscription`](/docs/api/quotes/create-a-quote-for-update-subscription-items),\
        \ the target resource is a `subscription` resource.\n"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            A unique and immutable identifier for the business entity. It is always autogenerated.
          maxLength: 50
          example: null
        name:
          type: string
          deprecated: false
          description: |
            A human-friendly name for the business entity.
          maxLength: 100
          example: null
        status:
          type: string
          deprecated: false
          description: |
            Current status of the business entity.

            * active - The business entity is active and can be used.
            * inactive - The business entity is inactive and cannot be used.
          enum:
          - active
          - inactive
          example: null
        deleted:
          type: boolean
          default: false
          deprecated: false
          description: |
            Indicates that the business entity has been deleted.
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp when this business entity was created.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            Version number of this resource. The `resource_version`
            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.
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The time period when the business entity was updated.
          example: null
      required:
      - created_at
      - deleted
      - id
      - name
      - status
      example: null
    BusinessEntityCreatedEvent:
      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:
            business_entity:
              $ref: "#/components/schemas/BusinessEntity"
          required:
          - business_entity
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    BusinessEntityDeletedEvent:
      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:
            business_entity:
              $ref: "#/components/schemas/BusinessEntity"
          required:
          - business_entity
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    BusinessEntityTransfer:
      type: object
      description: "`business_entity_transfer`\nencapsulates the details of the movement\
        \ of a resource (such as [customer](/docs/api/customers)\nand [subscription](/docs/api/subscriptions)\n\
        ) from one [business_entity](/docs/api/business_entities)\nto another.  \n\
        **Related Endpoints**\n\n* [Transfer resource to another business entity](/docs/api/business_entities/transfer-resources-to-another-business-entity)\n\
        * [List business entity transfers](/docs/api/business_entities/list-the-business-entity-transfers)\n"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Unique identifier of the `business_entity_transfer`.
            Chargebee automatically generates this.
          maxLength: 50
          example: null
        resource_type:
          type: string
          deprecated: false
          description: |
            The type of the resource that was transferred.

            * customer -
              Represents the transfer of a [customer](/docs/api/customers)
              resource.
            * subscription -
              Represents the transfer of a [subscriptions](/docs/api/subscriptions)
              resource linked to a [customer](/docs/api/customers)
              resource.
          enum:
          - customer
          - subscription
          example: null
        resource_id:
          type: string
          deprecated: false
          description: |
            The `id`
            of the deprecated version of the resource. This is the resource linked to the source [business_entity](/docs/api/business_entities)
            .
          maxLength: 50
          example: null
        active_resource_id:
          type: string
          deprecated: false
          description: |
            The `id`
            of the active version of the resource. This is the resource linked to the destination [business_entity](/docs/api/business_entities)
            .
          maxLength: 50
          example: null
        destination_business_entity_id:
          type: string
          deprecated: false
          description: |
            The unique identifier of the [business_entity](/docs/api/business_entities)
            to which the resource has been transferred.
          maxLength: 50
          example: null
        source_business_entity_id:
          type: string
          deprecated: false
          description: |
            The unique identifier of the [business_entity](/docs/api/business_entities)
            from which the resource has been transferred.
          maxLength: 50
          example: null
        reason_code:
          type: string
          deprecated: false
          description: |
            The reason for transferring the resource to another business entity.

            * correction - Correction of a wrongly assigned business entity.
          enum:
          - correction
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this business entity transfer record was created.
          example: null
      required:
      - active_resource_id
      - created_at
      - destination_business_entity_id
      - id
      - reason_code
      - resource_id
      - resource_type
      - source_business_entity_id
      example: null
    BusinessEntityUpdatedEvent:
      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:
            business_entity:
              $ref: "#/components/schemas/BusinessEntity"
          required:
          - business_entity
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    BusinessProfile:
      type: object
      example: null
    BusinessRule:
      type: object
      description: "A business rule pairs a condition with the actions to take when\
        \ that condition is met. You supply the context to evaluate, and Chargebee\
        \ returns the actions configured in `actions_on_success` when the condition\
        \ evaluates to `true`.\n\nThe condition is defined in `structured_expression`,\
        \ a JSON representation of the rule logic that visual editors and dynamic\
        \ rule builders can both read and write. Chargebee validates and compiles\
        \ the expression when the rule is created or updated, and evaluates the compiled\
        \ form when you call [Apply business rules](/docs/api/business_rules/apply-business-rules).\n\
        \nThe `field` of every condition is resolved against the context supplied\
        \ at evaluation time, so the fields you reference must match the keys of the\
        \ context the rule is evaluated against. A condition whose `field` is absent\
        \ from the context never evaluates to `true`, which means the rule never matches.\n\
        \nBusiness rules are versioned. Creating a rule releases its first version,\
        \ so `latest_version` is `1` and `released_at` is set from the outset. Editing\
        \ a rule leaves that released version untouched: the first edit creates a\
        \ draft, and every later edit updates the same draft. [Releasing](/docs/api/business_rules/release-a-business-rule)\
        \ the draft promotes it to the next version number, and that version becomes\
        \ the latest released version and the one Chargebee evaluates. Until you release\
        \ it, the previously released version stays in effect, so a rule can keep\
        \ serving traffic while its next version is being prepared.\n\nThe `active`\
        \ attribute is an independent switch that controls whether Chargebee evaluates\
        \ the rule at all. A rule is created inactive, so it has to be [activated](/docs/api/business_rules/activate-a-business-rule)\
        \ before it takes effect.\n\nRelated rules can be grouped into a [business\
        \ ruleset](/docs/api/business_rulesets), which evaluates its member rules\
        \ in priority order using the strategy configured in the ruleset's `execute_mode`.\n\
        \nFor a walkthrough that creates, activates, and applies a rule in three calls,\
        \ take a look at the [Business Rules quickstart](https://www.chargebee.com/tutorials/business-rules-quickstart/).\
        \  \n**Note:** Business rules are not enabled by default. Contact [Chargebee\
        \ Support](https://www.chargebee.com/support/) to enable them for your site.\
        \ Until they are enabled, these endpoints return an error.\n\nExpressions\n\
        -----------\n\nThe `structured_expression` of a rule is a tree of nodes that\
        \ evaluates to a single `true` or `false`. Every node carries a `type`, which\
        \ determines the rest of the fields the node takes.\n\nThe following expression\
        \ matches a quote from a customer whose language contains `en` and whose shipping\
        \ country is India or the United States:\n\n```json\n{\n  \"type\": \"GROUP\"\
        ,\n  \"operation\": \"AND\",\n  \"children\": [\n    {\n      \"type\": \"\
        CONDITION\",\n      \"field\": \"customer.language\",\n      \"operator\"\
        : \"CONTAINS\",\n      \"value\": \"en\"\n    },\n    {\n      \"type\": \"\
        CONDITION\",\n      \"field\": \"quote.shipping_address_country\",\n     \
        \ \"operator\": \"ANY_OF\",\n      \"values\": [\"IN\", \"US\"]\n    }\n \
        \ ]\n}\n```\n\nEvery condition is compiled so that it first tests whether\
        \ the field is present in the context. A condition on a field that the context\
        \ doesn't carry evaluates to `false` instead of failing, so the rule that\
        \ holds it never matches and no `error_message` is returned for it.  \n\n\
        ### GROUP node\n\nCombines the nodes in `children` into a single result. Use\
        \ a `GROUP` as the root of any expression that has more than one condition,\
        \ and nest groups to control precedence.\n\n* `operation`: **Required.** `AND`\
        \ to match only if every child matches, or `OR` to match if any child matches.\n\
        * `children`: **Required.** An array holding at least one node. Each entry\
        \ is itself a `GROUP`, `CONDITION`, or `COLLECTION` node.\n\n```json\n{\n\
        \  \"type\": \"GROUP\",\n  \"operation\": \"OR\",\n  \"children\": [\n   \
        \ {\n      \"type\": \"CONDITION\",\n      \"field\": \"quote.payment_terms\"\
        ,\n      \"operator\": \"GREATER_THAN\",\n      \"value\": 30\n    },\n  \
        \  {\n      \"type\": \"CONDITION\",\n      \"field\": \"customer.billing_address_country\"\
        ,\n      \"operator\": \"EQUALS\",\n      \"value\": \"US\"\n    }\n  ]\n\
        }\n```\n\n### CONDITION node\n\nCompares one field of the context against\
        \ a value.\n\n* `field`: **Required.** The path of the field through the context,\
        \ such as `customer.language`. See [Context](/docs/api/business_rules#context)\
        \ for the paths available.\n* `operator`: **Required.** How the comparison\
        \ is made. See [Operators](/docs/api/business_rules#operators) for the operators\
        \ available and the field types each one compares.\n* `value`: The single\
        \ value to compare against. Required for the single-value operators.\n* `values`:\
        \ The array of values to compare against. Required for `BETWEEN`, `ANY_OF`,\
        \ and `NONE_OF`.\n\n```json\n{\n  \"type\": \"CONDITION\",\n  \"field\": \"\
        quote.contract_duration\",\n  \"operator\": \"BETWEEN\",\n  \"values\": [12,\
        \ 36]\n}\n```\n\n### COLLECTION node\n\nTests the entries of an array in the\
        \ context, such as the line items of a quote. All four fields are required.\n\
        \n* `field`: **Required.** The array to iterate over, such as `items`.\n*\
        \ `variable`: **Required.** The name each entry is bound to while the predicate\
        \ is evaluated.\n* `mode`: **Required.** `ANY` to match if at least one entry\
        \ satisfies the predicate, or `NONE` to match only if no entry does.\n* `predicate`:\
        \ **Required.** The expression each entry is tested against, usually a `GROUP`\
        \ node.\n\nInside the predicate, address the fields of an entry through the\
        \ bound `variable`. The following node matches a quote that has at least one\
        \ item discounted by more than 20:\n\n```json\n{\n  \"type\": \"COLLECTION\"\
        ,\n  \"field\": \"items\",\n  \"variable\": \"item\",\n  \"mode\": \"ANY\"\
        ,\n  \"predicate\": {\n    \"type\": \"GROUP\",\n    \"operation\": \"AND\"\
        ,\n    \"children\": [\n      {\n        \"type\": \"CONDITION\",\n      \
        \  \"field\": \"item.discount\",\n        \"operator\": \"GREATER_THAN\",\n\
        \        \"value\": 20\n      }\n    ]\n  }\n}\n```\n\n### Operators\n\nThe\
        \ following operators are available. The field type is the type the operator\
        \ can compare, and the value column shows whether the condition takes `value`\
        \ or `values`.  \n\n|                                   Operator         \
        \                          |       Field type        |                   \
        \                     Value                                        |\n|------------------------------------------------------------------------------|-------------------------|-------------------------------------------------------------------------------------|\n\
        | `EQUALS`, `NOT_EQUALS`                                                 \
        \      | String, number, boolean | `value`                               \
        \                                              |\n| `GREATER_THAN`, `GREATER_THAN_OR_EQUALS`,\
        \ `LESS_THAN`, `LESS_THAN_OR_EQUALS` | Number                  | `value` \
        \                                                                        \
        \    |\n| `BETWEEN`                                                      \
        \              | Number                  | `values`, holding exactly two entries,\
        \ read as the inclusive lower and upper bounds |\n| `CONTAINS`, `NOT_CONTAINS`\
        \                                                   | String             \
        \     | `value`                                                          \
        \                   |\n| `STARTS_WITH`                                   \
        \                             | String                  | `value`        \
        \                                                                     |\n\
        | `ANY_OF`, `NONE_OF`                                                    \
        \      | String, number, boolean | `values`, holding at least one entry  \
        \                                              |\n\nAn operator used on a\
        \ field of another type isn't rejected when the rule is saved, so the mismatch\
        \ surfaces only when the rule is evaluated.\n\nContext\n-------\n\nThe `context`\
        \ you pass to [Apply business rules](/docs/api/business_rules/apply-business-rules)\
        \ isn't a free-form object. Its `type` selects the schema that the rest of\
        \ the context is read as, and `CPQ` is the only type available, so a condition\
        \ can reference only the fields of that schema. A key that falls outside the\
        \ schema is dropped as the context is read, so a condition on it never evaluates\
        \ to `true`. A misspelled or unsupported key therefore surfaces as an unmet\
        \ condition rather than as an error.\n\nA `CPQ` context carries `items`, `quote`,\
        \ `customer`, `user`, `site`, and `quote_subscription`, each of them optional.\
        \ Pass only the parts the rules you're evaluating need:\n\n```json\n{\n  \"\
        type\": \"CPQ\",\n  \"customer\": {\n    \"language\": \"en\",\n    \"billing_address_country\"\
        : \"US\"\n  },\n  \"quote\": {\n    \"shipping_address_country\": \"IN\",\n\
        \    \"payment_terms\": 30,\n    \"custom_fields\": { \"region\": \"apac\"\
        \ }\n  },\n  \"items\": [\n    { \"reference_id\": \"item-1\", \"amount\"\
        : 5000, \"quantity\": 2, \"discount\": 10 },\n    { \"reference_id\": \"item-2\"\
        , \"amount\": 1200, \"quantity\": 1, \"discount\": 0 }\n  ]\n}\n```\n\nA condition\
        \ addresses a field by its path through the context, so `customer.language`\
        \ reads the `language` of the `customer`. A `COLLECTION` node on `items` iterates\
        \ over the entries of that array.\n\nEach `custom_fields` object holds your\
        \ own fields keyed by name, and every value must be a string, a number, or\
        \ a boolean. A condition reads one through its key, as in `quote.custom_fields.region`.\n\
        \nThe response returns the context back with `rule_ids` filled in on the quote\
        \ and on each item, so you can see which rules applied where.  \n\n### quote\n\
        \n* `type` and `contract_type`: strings.\n* `contract_duration` and `payment_terms`:\
        \ numbers.\n* `billing_address_country` and `shipping_address_country`: strings.\n\
        * `billing_frequency` and `billing_currency`: strings.\n* `creator_email`\
        \ and `creator_role`: strings.\n* `custom_fields`: object.\n* `rule_ids`:\
        \ array of strings. Returned in the response rather than passed, recording\
        \ the rules that applied to the quote.  \n\n### customer\n\n* `billing_address_city`,\
        \ `billing_address_state`, and `billing_address_country`: strings.\n* `language`:\
        \ string.\n* `payment_terms`: number.\n* `custom_fields`: object.  \n\n###\
        \ items\n\nAn array, with each entry holding the following.\n\n* `reference_id`:\
        \ string, identifying the entry within the context.\n* `type`, `item_name`,\
        \ and `product_family_name`: strings.\n* `billing_frequency` and `currency`:\
        \ strings.\n* `billing_cycle`, `amount`, `quantity`, and `discount`: numbers.\n\
        * `start_date` and `end_date`: timestamps.\n* `rule_ids`: array of strings.\
        \ Returned in the response rather than passed, recording the rules that applied\
        \ to that entry.  \n\n### user\n\n* `name`, `email`, and `phone`: strings.\
        \  \n\n### site\n\n* `name`, `domain`, and `currency`: strings.\n* `sandbox`:\
        \ boolean.  \n\n### quote_subscription\n\n* `custom_fields`: object.\n\nActions\n\
        -------\n\nEvery entry in `actions_on_success` is built from an **action template**\
        \ , a built-in definition that fixes the kind of change an action makes and\
        \ the parameters it accepts. An action names its template in `action_template_id`\
        \ and passes that template's parameters in `input`:\n\n```json\n[\n  {\n \
        \   \"action_template_id\": \"action-apply-discount\",\n    \"input\": {\n\
        \      \"apply_on\": \"INVOICE_AMOUNT\",\n      \"discount\": 12.0,\n    \
        \  \"discount_type\": \"PERCENTAGE\",\n      \"duration_type\": \"ONE_TIME\"\
        \n    }\n  }\n]\n```\n\nThe `type` of an action is derived from its template,\
        \ so it's returned with the action but you don't have to pass it. A parameter\
        \ that the template doesn't define is rejected. The values of enumerated parameters\
        \ are matched without regard to case, and are returned in the `input` of the\
        \ action exactly as you passed them.\n\nAn action can also carry a `structured_expression`\
        \ of its own, written in the same format as the expression of the rule. The\
        \ rule decides whether the action runs at all, and the action's own expression\
        \ then narrows it to the items of the context that satisfy that expression.\
        \ One rule can therefore discount some of the items it matched rather than\
        \ all of them. Only the apply discount, limit discount, and limit quantity\
        \ templates accept an action-level expression.  \n\n### Apply discount\n\n\
        Applies a discount to the invoice amount or to specific item prices. Built\
        \ from `action_template_id` `action-apply-discount` and returned with `type`\
        \ `APPLY_DISCOUNT`.\n\n* `apply_on`: **Required.** `INVOICE_AMOUNT` to discount\
        \ the invoice total, or `SPECIFIC_ITEM_PRICE` to discount the item prices\
        \ the action applies to.\n* `discount`: **Required.** The discount to apply,\
        \ such as `12.0`.\n* `discount_type`: **Required.** `PERCENTAGE`, `FLAT_FEE`,\
        \ or `OFFER_QUANTITY`, which fixes how `discount` is read.\n* `duration_type`:\
        \ **Required.** How long the discount applies, as `ONE_TIME`, `FOREVER`, or\
        \ `LIMITED_PERIOD`.\n* `period_unit`: `DAY`, `WEEK`, `MONTH`, or `YEAR`. Required\
        \ if `duration_type` is `LIMITED_PERIOD`.\n* `period`: The number of `period_unit`s\
        \ the discount applies for. Required if `period_unit` is passed.  \n\n###\
        \ Apply coupon\n\nApplies existing [coupons](/docs/api/coupons). Built from\
        \ `action_template_id` `action-apply-coupon` and returned with `type` `APPLY_COUPON`.\n\
        \n* `apply_on`: **Required.** `INVOICE_AMOUNT` or `SPECIFIC_ITEM_PRICE`.\n\
        * `coupon_ids`: **Required.** The coupons to apply, as an array of coupon\
        \ identifiers. It must hold at least one identifier.  \n\n### Limit discount\n\
        \nCaps the discount that can be given. Use this template to enforce a discount\
        \ ceiling without an approval step.\n\nBuilt from `action_template_id` `action-limit-discount`\
        \ and returned with `type` `LIMIT_DISCOUNT`.\n\n* `apply_on`: **Required.**\
        \ `INVOICE_AMOUNT` or `SPECIFIC_ITEM_PRICE`.\n* `maximum_discount`: **Required.**\
        \ The largest discount allowed, such as `20.0`.\n* `discount_type`: **Required.**\
        \ `PERCENTAGE`, `FLAT_FEE`, or `OFFER_QUANTITY`, which fixes how `maximum_discount`\
        \ is read.\n* `disable_price_override`: Pass `true` to disallow overriding\
        \ the price outright.  \n\n### Limit quantity\n\nConstrains the quantities\
        \ that can be selected. Built from `action_template_id` `action-limit-quantity`\
        \ and returned with `type` `LIMIT_QUANTITY`. Every parameter is optional,\
        \ so pass the ones you want to enforce.\n\n* `minimum_quantity`: The smallest\
        \ quantity allowed.\n* `maximum_quantity`: The largest quantity allowed.\n\
        * `quantity_step_count`: The increment the quantity can be changed in, so\
        \ `5` allows 5, 10, 15, and so on.  \n\n### Error\n\nReturns an error message\
        \ instead of a change. Use this template to block an operation when the rule\
        \ matches.\n\nBuilt from `action_template_id` `action-error` and returned\
        \ with `type` `ERROR`.\n\n* `error_message`: **Required.** The message returned\
        \ with the action.\n\nEvaluation results\n------------------\n\n[Apply business\
        \ rules](/docs/api/business_rules/apply-business-rules) returns an `apply_rule`\
        \ object that echoes back the `context` you passed and carries one entry in\
        \ `rules` for each rule it evaluated:\n\n```json\n{\n  \"apply_rule\": {\n\
        \    \"context\": {\n      \"type\": \"CPQ\",\n      \"customer\": { \"language\"\
        : \"en\" },\n      \"quote\": { \"shipping_address_country\": \"IN\" }\n \
        \   },\n    \"rules\": [\n      {\n        \"id\": \"quote-discount-en\",\n\
        \        \"version\": 1,\n        \"name\": \"Apply 12 percent discount at\
        \ invoice level\",\n        \"evaluation_result\": true,\n        \"actions\"\
        : [\n          {\n            \"action_template_id\": \"action-apply-discount\"\
        ,\n            \"type\": \"APPLY_DISCOUNT\",\n            \"input\": {\n \
        \             \"apply_on\": \"INVOICE_AMOUNT\",\n              \"discount\"\
        : 12.0,\n              \"discount_type\": \"PERCENTAGE\",\n              \"\
        duration_type\": \"ONE_TIME\"\n            }\n          }\n        ],\n  \
        \      \"object\": \"applied_rule\"\n      },\n      {\n        \"id\": \"\
        quote-discount-uk\",\n        \"version\": 1,\n        \"name\": \"Apply 5\
        \ percent discount at invoice level for UK quotes\",\n        \"evaluation_result\"\
        : false,\n        \"object\": \"applied_rule\"\n      }\n    ],\n    \"object\"\
        : \"apply_rule\"\n  }\n}\n```\n\nRead the result of each rule from `evaluation_result`,\
        \ and read what the rule produced from `actions`. Two things about the shape\
        \ are worth knowing before you write code against it.\n\n* `actions` is absent,\
        \ rather than empty, for a rule whose `evaluation_result` is `false`. The\
        \ second entry above shows a rule that didn't match.\n* An entry for an ad\
        \ hoc `structured_expression` carries only `evaluation_result`, because there's\
        \ no stored rule to report an `id`, `name`, or `actions` for.\n\nA rule that\
        \ couldn't be evaluated is returned with `error_message` set instead, but\
        \ only if you passed `skip_failed_rules` as `true`. Otherwise the request\
        \ fails. For the full list of fields, see the response of [Apply business\
        \ rules](/docs/api/business_rules/apply-business-rules).\n"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Unique identifier of the business rule.
          maxLength: 100
          example: null
        name:
          type: string
          deprecated: false
          description: |
            Display name of the business rule.
          maxLength: 500
          example: null
        description:
          type: string
          deprecated: false
          description: |
            Description of what the business rule does.
          maxLength: 1000
          example: null
        latest_version:
          type: integer
          format: int32
          deprecated: false
          description: |
            Version number of the released version that is currently in effect. It is `1` for a newly created rule, and is incremented every time a draft is released.
          example: null
        active:
          type: boolean
          deprecated: false
          description: |
            Whether Chargebee evaluates the rule. A rule is created inactive. Use [Activate a business rule](/docs/api/business_rules/activate-a-business-rule) and [Deactivate a business rule](/docs/api/business_rules/deactivate-a-business-rule) to change this value.
          example: null
        released_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp at which the version in `latest_version` was released. It is set when the rule is created and updated on every subsequent release.
          example: null
        released_by:
          type: string
          deprecated: false
          description: |
            User or API key that released the version in `latest_version`.
          maxLength: 100
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp at which the rule was last modified.
          example: null
        updated_by:
          type: string
          deprecated: false
          description: |
            User or API key that last modified the rule.
          maxLength: 100
          example: null
        created_by:
          type: string
          deprecated: false
          description: |
            User or API key that created the rule.
          maxLength: 100
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp at which the rule was created.
          example: null
        tags:
          type: array
          deprecated: false
          items:
            example: null
          example: null
        structured_expression:
          type: object
          additionalProperties: true
          deprecated: false
          description: |
            A structured JSON representation of the rule logic, used for programmatic interpretation and for rendering the rule in visual editors and dynamic builders.

            See [Expressions](/docs/api/business_rules#expressions) for the node types and the operators each field type supports, and [Context](/docs/api/business_rules#context) for the fields a condition can reference.
          example: null
        actions_on_success:
          type: array
          deprecated: false
          description: |
            The actions returned by Chargebee when the rule expression evaluates to `true`. Each action carries its `type`, the `action_template_id` of the template it is built from, and the parameters of that template in `input`.

            See [Actions](/docs/api/business_rules#actions) for the templates available, the parameters each one takes, and the optional action-level `structured_expression`.
          items:
            example: null
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            Version number of this resource. Each update of the resource increments the `resource_version`. Concurrent updates can be detected by comparing this value across requests.
          example: null
      required:
      - active
      - created_at
      - created_by
      - id
      - name
      - updated_at
      example: null
    BusinessRuleActivatedEvent:
      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:
            business_rule:
              $ref: "#/components/schemas/BusinessRule"
          required:
          - business_rule
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    BusinessRuleCreatedEvent:
      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:
            business_rule:
              $ref: "#/components/schemas/BusinessRule"
          required:
          - business_rule
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    BusinessRuleDeactivatedEvent:
      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:
            business_rule:
              $ref: "#/components/schemas/BusinessRule"
          required:
          - business_rule
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    BusinessRuleDeletedEvent:
      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:
            business_rule:
              $ref: "#/components/schemas/BusinessRule"
          required:
          - business_rule
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    BusinessRuleReleasedEvent:
      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:
            business_rule:
              $ref: "#/components/schemas/BusinessRule"
          required:
          - business_rule
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    BusinessRuleUpdatedEvent:
      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:
            business_rule:
              $ref: "#/components/schemas/BusinessRule"
          required:
          - business_rule
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    BusinessRulesAppliedEvent:
      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:
            business_rules_applied:
              $ref: "#/components/schemas/AppliedBusinessRule"
          required:
          - business_rules_applied
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    BusinessRuleset:
      type: object
      description: "A business ruleset groups [business rules](/docs/api/business_rules)\
        \ so that they can be evaluated together, in the priority order you assign,\
        \ using the strategy set in `execute_mode`.\n\nRulesets let you apply a whole\
        \ decision at once instead of calling each rule separately. Passing a `ruleset_id`\
        \ to [Apply business rules](/docs/api/business_rules/apply-business-rules)\
        \ evaluates the rules the ruleset contains in their priority order and returns\
        \ a result for each one. The `execute_mode` decides whether evaluation runs\
        \ through every rule or stops as soon as a rule evaluates to `true` or to\
        \ `false`, and which of the results are returned.\n\nMembership is managed\
        \ separately from the rules themselves. [Add business rules to a ruleset](/docs/api/business_rulesets/add-business-rules-to-a-ruleset)\
        \ and [Remove business rules from a ruleset](/docs/api/business_rulesets/remove-business-rules-from-a-ruleset)\
        \ change membership incrementally, while passing `rules` to [Update a business\
        \ ruleset](/docs/api/business_rulesets/update-a-business-ruleset) replaces\
        \ it entirely. A rule can belong to more than one ruleset, and removing it\
        \ from a ruleset does not delete the rule.\n\nThe `active` attribute controls\
        \ whether Chargebee evaluates the ruleset. A rule is evaluated through a ruleset\
        \ only when both the ruleset and the rule are `active`.  \n**Note:** Business\
        \ rules are not enabled by default. Contact [Chargebee Support](https://www.chargebee.com/support/)\
        \ to enable them for your site. Until they are enabled, these endpoints return\
        \ an error.\n"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Unique identifier of the business ruleset.
          maxLength: 100
          example: null
        name:
          type: string
          deprecated: false
          description: |
            Display name of the business ruleset.
          maxLength: 500
          example: null
        description:
          type: string
          deprecated: false
          description: |
            Description of what the business ruleset does.
          maxLength: 1000
          example: null
        active:
          type: boolean
          deprecated: false
          description: |
            Whether Chargebee evaluates the ruleset. Use [Activate a business ruleset](/docs/api/business_rulesets/activate-a-business-ruleset) and [Deactivate a business ruleset](/docs/api/business_rulesets/deactivate-a-business-ruleset) to change this value.
          example: null
        execute_mode:
          type: string
          default: execute_all
          deprecated: false
          description: |
            Strategy that determines how the rules in the ruleset are evaluated and when evaluation stops.

            * execute_all_true - Every rule in the ruleset is evaluated, and only the rules that evaluated to `true` are returned.
            * stop_on_first_false - Evaluation stops as soon as a rule evaluates to `false`. The rules that come later in the evaluation order are not evaluated.
            * execute_all - Every rule in the ruleset is evaluated and all the results are returned. This is the default.
            * stop_on_first_true - Evaluation stops as soon as a rule evaluates to `true`. The rules that come later in the evaluation order are not evaluated.
          enum:
          - stop_on_first_true
          - stop_on_first_false
          - execute_all
          - execute_all_true
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp at which the ruleset was last modified.
          example: null
        updated_by:
          type: string
          deprecated: false
          description: |
            User or API key that last modified the ruleset.
          maxLength: 100
          example: null
        created_by:
          type: string
          deprecated: false
          description: |
            User or API key that created the ruleset.
          maxLength: 100
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp at which the ruleset was created.
          example: null
        rules:
          type: array
          deprecated: false
          description: |
            The [business rules](/docs/api/business_rules) that belong to the ruleset, each with the `rule_id` of the rule and the `priority` that determines its position in the ruleset's evaluation order. Priorities are unique within a ruleset.

            Only the identifier and priority of each rule are carried here, not its expression or actions. Use [List rules in a business ruleset](/docs/api/business_rulesets/list-rules-in-a-business-ruleset) to page through the membership of a ruleset, and [Retrieve a business rule](/docs/api/business_rules/retrieve-a-business-rule) to read a rule's definition.
          items:
            example: null
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            Version number of this resource. Each update of the resource increments the `resource_version`. Concurrent updates can be detected by comparing this value across requests.
          example: null
      required:
      - active
      - created_at
      - created_by
      - execute_mode
      - id
      - name
      - updated_at
      example: null
    BusinessRulesetActivatedEvent:
      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:
            business_ruleset:
              $ref: "#/components/schemas/BusinessRuleset"
          required:
          - business_ruleset
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    BusinessRulesetCreatedEvent:
      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:
            business_ruleset:
              $ref: "#/components/schemas/BusinessRuleset"
          required:
          - business_ruleset
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    BusinessRulesetDeactivatedEvent:
      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:
            business_ruleset:
              $ref: "#/components/schemas/BusinessRuleset"
          required:
          - business_ruleset
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    BusinessRulesetDeletedEvent:
      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:
            business_ruleset:
              $ref: "#/components/schemas/BusinessRuleset"
          required:
          - business_ruleset
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    BusinessRulesetRule:
      type: object
      properties:
        rule_id:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        priority:
          type: integer
          format: int32
          deprecated: false
          example: null
      required:
      - priority
      - rule_id
      example: null
    BusinessRulesetUpdatedEvent:
      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:
            business_ruleset:
              $ref: "#/components/schemas/BusinessRuleset"
          required:
          - business_ruleset
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      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/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\n\
            * twikey - Twikey is a payment service provider that specializes in processing\
            \ direct debit payments across the EU.\n* bluesnap - BlueSnap is a payment\
            \ gateway.\n* jp_morgan -\n  J.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).\
            \  \n  This 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 - 2Checkout is a payment gateway.\n\
            * payway - Payway is a payment gateway that enables secure card and payment\
            \ acceptance.\n* moyasar - Moyasar is a fully integrated online payment\
            \ service that makes accepting payments simple and secure.\n* deutsche_bank\
            \ -\n  Deutsche Bank is the leading German bank with strong European roots\
            \ and a global network.  \n  This feature is a **Private Beta Release**.\n\
            * bluepay - BluePay is a payment gateway.\n* paypal_express_checkout -\
            \ PayPal Express Checkout is a payment gateway.\n* paypal_payflow_pro\
            \ - PayPal Payflow Pro is a payment gateway.\n* 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.\n* global_payments - Global Payments is a payment service provider.\n\
            * dlocal - Dlocal provides payment solutions for global commerce by accepting\
            \ local payment methods.\n* not_applicable - Indicates that payment gateway\
            \ is not applicable for this resource.\n* checkout_com - Checkout.com\
            \ is a payment gateway.\n* adyen - Adyen is a payment gateway.\n* braintree\
            \ - Braintree is a payment gateway.\n* nmi - NMI is a payment gateway.\n\
            * worldpay - WorldPay is a payment gateway\n* paystack -\n  Paystack is\
            \ a payment gateway for businesses in Africa. It enables secure payment\
            \ acceptance both online and offline.  \n  This 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 - Pay.com\
            \ provides payment services focused on simplicity and hassle-free operations\
            \ for businesses of all sizes.\n* moneris_us - Moneris USA is a payment\
            \ gateway.\n* pin - Pin is a payment gateway\n* authorize_net - Authorize.net\
            \ is a payment gateway\n* tempus - Tempus Technologies is a payment gateway\
            \ and payments technology provider offering secure payment processing\
            \ with point-to-point encryption (P2PE) and tokenization.\n* stripe -\
            \ Stripe is a payment gateway.\n* moneris - Moneris is a payment gateway.\n\
            * chargebee - Chargebee test gateway.\n* cybersource - CyberSource is\
            \ a payment gateway.\n* ecentric - Ecentric provides a seamless payment\
            \ processing service in South Africa specializing on omnichannel capabilities.\n\
            * first_data_global - First Data Global Gateway Virtual Terminal Account\n\
            * exact - Exact Payments is a payment gateway.\n* nuvei -\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.\
            \  \n  This 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 - eWAY Account\
            \ is a payment gateway.\n* metrics_global - Metrics global is a leading\
            \ payment service provider providing unified payment services in the US.\n\
            * payu - PayU is a payment gateway that enables secure card payment acceptance\
            \ via PaymentsOS.\n* amazon_payments - Amazon Payments is a payment service\
            \ provider.\n* windcave - Windcave provides an end to end payment processing\
            \ solution in ANZ and other leading global markets.\n* quickbooks - Intuit\
            \ QuickBooks Payments gateway\n* wepay - WePay is a payment gateway.\n\
            * ezidebit -\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* wirecard - WireCard\
            \ Account is a payment service provider.\n* chargebee_payments - Chargebee\
            \ Payments gateway\n* sage_pay - Sage Pay is a payment gateway.\n* elavon\
            \ - Elavon Virtual Merchant is a payment solution.\n* paypal_pro - PayPal\
            \ Pro Account is a payment gateway.\n* orbital - Chase Paymentech(Orbital)\
            \ is a payment gateway.\n* paypal - PayPal Commerce is a payment gateway.\n\
            * beanstream - Bambora(formerly known as Beanstream) is a payment gateway.\n\
            * hdfc - HDFC Account is a payment gateway.\n* ingenico_direct - Worldline\
            \ Online Payments is a payment gateway.\n* ogone - Ingenico ePayments\
            \ (formerly known as Ogone) is a payment gateway.\n* migs - MasterCard\
            \ Internet Gateway Service payment gateway.\n* vantiv - Vantiv is a payment\
            \ gateway.\n* bank_of_america - Bank of America Gateway\n* eway_rapid\
            \ - eWAY Rapid is a payment gateway.\n* gocardless - GoCardless is a payment\
            \ service provider.\n* mollie - Mollie is a payment gateway.\n* paymill\
            \ - PAYMILL is a payment gateway.\n* balanced_payments - Balanced is a\
            \ payment gateway\n* solidgate -\n  Solidgate is a secure and reliable\
            \ payment processing solution that allows you to accept payments from\
            \ customers and suitable for various types of businesses.  \n  This feature\
            \ is a **Private Beta Release**.\n* ebanx - EBANX 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
          - payu
          - 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: |
            The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
            without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `billing_state_code`
            as `AZ`
            (not `US-AZ`
            ). For Tamil Nadu (India), set as `TN`
            (not `IN-TN`
            ). For British Columbia (Canada), set as `BC`
            (not `CA-BC`
            ). For Dubai (UAE), set as `DU`
            (not `AE-DU`
            ).
          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: "The billing address country of the customer. Must be one of\
            \ [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
            .\n\n**Note**:\nIf you enter an invalid country code, the system will\
            \ return an error.  \n**Brexit**\n\nIf you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
            \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
            \ the Brexit configuration, then `XI` (the code for **United Kingdom -\
            \ Northern Ireland**) is available as an option.\n"
          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: |
            Version number of this resource. The `resource_version`
            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.
          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 is 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
    ChargeEntitlement:
      type: object
      properties:
        entity_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        parent_entity_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        entity_type:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        line_item_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        quantity:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        value:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        feature_name:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        feature_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        name:
          type: string
          deprecated: false
          maxLength: 50
          example: null
      example: null
    ChargeModel:
      type: string
      deprecated: true
      enum:
      - full_charge
      - prorate
      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
    ColumnDefinition:
      type: object
      properties:
        column_name:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        data_type:
          type: string
          deprecated: false
          enum:
          - number
          - string
          example: null
      required:
      - column_name
      - data_type
      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, for example, 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
            * plan - Entity that represents a subscription plan
            * price_variant - Entity that represents a price variant
            * 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
            * 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
          - item_family
          - item
          - item_price
          - price_variant
          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
          description: |
            The unique identifier of the [business entity](/docs/api/business_entities)
            associated with this comment.
          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: |
            The Chargebee [site](https://www.chargebee.com/docs/2.0/sites-intro.html)
            for which the information has been requested. It is the same as the value of `{site}`
            provided as a path parameter.
          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: |
        Subscriptions can run indefinitely or they may run for a fixed number of billing cycles. Subscription can have "contract terms", 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.

        The **contract term** resource described below defines the properties of this lock-in period. This includes the [number of billing cycles](/docs/api/contract_terms/contract_term-object#remaining_billing_cycles), the [total contract value](/docs/api/contract_terms/contract_term-object#total_contract_value), the [action to be taken](/docs/api/contract_terms/contract_term-object#action_at_term_end) at the end of the contract term, and so on. To allow for exceptions, you also have the option of terminating an [`active`](/docs/api/contract_terms/contract_term-object#status) contract term and charging a [termination fee](/docs/api/contract_terms).

        A contract term starts in the `active` state and ends in the `completed` state. If the contract was canceled due to non-payment or other reasons, it can end in the `canceled` or `terminated` state. A given contract term is always associated with one, and only one subscription. A subscription, however, can be associated with only one `active` contract term. Over time, a subscription can be associated with several non-`active` contract terms. The `active` contract term for a subscription is available as an [object](/docs/api/subscriptions/subscription-object#contract_term) within the subscription.

        To enable and configure contract terms, follow these steps in the Chargebee UI:

        1. Click **Settings** on the left navigation.
        2. Click **Configure Chargebee**.
        3. Under **Billing** , click **Contract Terms**.
        4. Enable and configure the feature as needed.

        Once contract terms have been configured, the following actions can be performed using the API:

        * **Define a contract term** for a subscription and **set renewal options** for the contract term. The following endpoints support this:

        * [Create a subscription](/docs/api/subscriptions/create-subscription-for-items)
        * [Update a subscription](/docs/api/subscriptions/update-subscription-for-items)
        * [Reactivate a subscription](/docs/api/subscriptions/reactivate-a-subscription)
        * [Create a subscription ramp](/docs/api/ramps/create-a-ramp)
        * [Update a subscription ramp](/docs/api/ramps/update-a-subscription-ramp)
        * **Retrieving** a historical record of all contract terms for a subscription can be done via the following endpoint:

        * [List contract terms for a subscription](/docs/api/subscriptions/list-contract-terms-for-a-subscription)
        * **Canceling a contract term** can be done via the following endpoints:

        * [Update a subscription](/docs/api/subscriptions/update-subscription-for-items)
        * [Cancel a subscription](/docs/api/subscriptions/cancel-subscription-for-items)
        * [Update a subscription ramp](/docs/api/ramps/update-a-subscription-ramp)

        #### Including a termination fee

        When a contract is canceled mid-term, you can set a termination fee to be levied. Here's how:

        1. [Create](/docs/api/item_prices/create-an-item-price) an item price for an item of [type](/docs/api/items/item-object#type) `charge` with [price](/docs/api/item_prices/create-an-item-price#price) set to the termination fee.
        2. Do one of the following:

        * [Attach the charge-item to a plan](/docs/api/attached_items/create-an-attached-item), setting the `charge_on_event` parameter to `contract_termination`. OR
        * [Include the charge-item price on a subscription](/docs/api/subscriptions/create-subscription-for-items), setting the `subscription_items[charge_on_event][i]` parameter to `contract_termination`.

        Once the above steps are done, the termination fee will be charged automatically if you [terminate the contract in the middle of its term](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option).
      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: |
            Action to be taken when the contract term completes.

            * renew -
              * Contract term completes and a new contract term is started for the number of billing cycles specified in [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).
              * The `action_at_term_end` for the new contract term is set to `renew`.
            * evergreen - Contract term completes and the subscription renews.
            * renew_once -
              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 [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).

              * The `action_at_term_end` for the new contract term is set to `cancel`.
            * cancel - Contract term completes and subscription is canceled.
          enum:
          - renew
          - evergreen
          - cancel
          - renew_once
          example: null
        total_contract_value:
          type: integer
          format: int64
          default: 0
          deprecated: false
          description: |
            The sum of the [totals](/docs/api/invoices/invoice-object#total)
            of all the invoices raised as part of the contract term. For `active`
            contract terms, this is a predicted value. The value depends on the [type of currency](/docs/api/contract_terms).
            If the subscription was [imported](/docs/api/contract_terms)
            with the contract term, then this value includes the value passed for `total_amount_raised`
            .
          minimum: 0
          example: null
        total_contract_value_before_tax:
          type: integer
          format: int64
          default: 0
          deprecated: false
          description: |
            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 `total_amount_raised_before_tax`
            is included in the calculation of the total contract value before tax. It's important to note that this value excludes any applicable taxes.
          minimum: 0
          example: null
        cancellation_cutoff_period:
          type: integer
          format: int32
          deprecated: false
          description: |
            The number of days before [`contract_end`](/docs/api/contract_terms/contract_term-object#contract_end)
            , 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.
          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: |
            The number of subscription billing cycles remaining after the current one for the contract term. This attribute is only returned for `active`
            contract terms.
          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: "Overview\n--------\n\nCoupons are deductions applied to invoices\
        \ or invoice line items. They'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.  \n**Note:**\n\nIf you wish to\
        \ provide discounts to your customers via API or the Chargebee app, see [Discounts\
        \ API](/docs/api/discounts)\n\nOrder of application of coupons and discounts\n\
        ---------------------------------------------\n\nWhen both [coupons](/docs/api/coupons)\
        \ and [discounts](/docs/api/discounts) are applied simultaneously to a [subscription](/docs/api/subscriptions)\
        \ or [one-time invoice](/docs/api/invoices/create-invoice-for-items-and-one-time-charges),\
        \ they're applied in the following order:  \n\n|---|---------------------------------------|-------------------------------------------------------------------------------------|\n\
        |   | **Summary**                           | **Description**            \
        \                                                         |\n| 1 | Line-level,\
        \ fixed amount coupons      | `coupon` with `apply_on` = `each_specified_item`\
        \ and `discount_type` = `flat`       |\n| 2 | Line-level, fixed amount discounts\
        \    | `discount` with `apply_on` = `specific_item_price` and `type` = `fixed_amount`\
        \      |\n| 3 | Line-level, percentage coupons        | `coupon` with `apply_on`\
        \ = `each_specified_item` and `discount_type` = `percentage` |\n| 4 | Line-level,\
        \ percentage discounts      | `discount` with `apply_on` = `specific_item_price`\
        \ and `type` = `percentage`        |\n| 5 | Invoice-level, fixed amount coupons\
        \   | `coupon` with `apply_on` = `invoice_amount` and `discount_type` = `flat`\
        \            |\n| 6 | Invoice-level, fixed amount discounts | `discount` with\
        \ `apply_on` = `invoice_amount` and `type` = `fixed_amount`           |\n\
        | 7 | Invoice-level, percentage coupons     | `coupon` with `apply_on` = `invoice_amount`\
        \ and `discount_type` = `percentage`      |\n| 8 | Invoice-level, percentage\
        \ discounts   | `discount` with `apply_on` = `invoice_amount` and `type` =\
        \ `percentage`             |\n\nFor example, consider the following scenario:\n\
        \nA subscription is created with:\n\n* a plan price of $200 per month\n* an\
        \ addon price of $20 per month\n* a flat $5 invoice discount\n* a 1% off coupon\
        \ on the addon\n* a flat $2 coupon on the invoice\n\nThe above coupons and\
        \ discount are applied in the following order:  \n\n|---|---------------------------------------------|-----------------------------------------------|\n\
        |   | **Discount or coupon applied**              | **Subtotal at each step**\
        \                     |\n| 1 | Initial subtotal (plan price + addon price)\
        \ | $200 + $20 = $220                             |\n| 2 | 1% off coupon on\
        \ the addon                  | $200 + $(20 - 0.02) = $200 + $19.98 = $219.98\
        \ |\n| 3 | Flat $2 coupon on the invoice               | $219.98 - $2 = $217.98\
        \                        |\n| 4 | Flat $5 invoice discount               \
        \     | $217.98 - $5 = **$212.98**                    |\n\n"
      properties:
        id:
          type: string
          deprecated: false
          description: "Used to uniquely identify the coupon in your website/application\
            \ and to integrate with Chargebee.  \n**Note:**\n\nWhen the coupon ID\
            \ contains a special character; for example: `#`, the API returns an error.\
            \ Make sure that you [encode](https://www.urlencoder.org/) the coupon\
            \ ID in the path parameter before making an API call.\n"
          maxLength: 100
          example: null
        name:
          type: string
          deprecated: false
          description: "The display name used in web interface for identifying the\
            \ coupon.  \n**Note:**\n\nWhen the name of the coupon set contains a special\
            \ character; for example: `#`, the API returns an error. Make sure that\
            \ you [encode](https://www.urlencoder.org/) the name of the coupon set\
            \ in the path parameter before making an API call.\n"
          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: "Specifies the type of discount to be applied.\n\n* percentage\
            \ -\n  A percentage of the original price is deducted as a discount. The\
            \ discount percentage is specified in [discount_percentage](/docs/api/coupons/coupon-object#discount_percentage).\
            \  \n  [Learn more](https://www.chargebee.com/docs/2.0/coupons.html#percentage-coupons)\n\
            \  about `percentage`\n  coupons.\n* fixed_amount -\n  A fixed amount\
            \ is deducted as a discount. The discount amount is specified in [discount_amount](/docs/api/coupons/coupon-object#discount_amount).\
            \  \n  [Learn more](https://www.chargebee.com/docs/2.0/coupons.html#fixed-amount-coupons)\n\
            \  about `fixed_amount`\n  coupons.\n* offer_quantity -\n  A specified\
            \ number of units of the item price are offered for free. The number of\
            \ free units is specified in [discount_quantity](/docs/api/coupons/coupon-object#discount_quantity).\n\
            \  The `offer_quantity`\n  option is valid only when [apply_on](/docs/api/coupons/coupon-object#apply_on)\n\
            \  is set to `each_specified_item`\n  and the [pricing_model](/docs/api/item_prices/item_price-object#pricing_model)\n\
            \  of the item price is `per_unit`.  \n  [Learn more](https://www.chargebee.com/docs/2.0/coupons.html#offer-quantity-coupons)\n\
            \  about `offer_quantity`\n  coupons.\n"
          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: |
            Specifies the number of free units provided for the [item price](/docs/api/item_prices)
            , without affecting the total quantity sold. This parameter is applicable only when the [discount_type](/docs/api/coupons/coupon-object#discount_type)
            is set to `offer_quantity`
            .
          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: |
            Specifies the time duration for which this coupon is attached to the subscription.

            * forever - The coupon is attached to the subscription and applied on the invoices until explicitly removed.
            * one_time -
              The coupon stays attached to the subscription till it is applied on an invoice **once**.
              It is removed after that from the subscription.
            * 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 `period`
              and `period_unit`
              .
          enum:
          - one_time
          - forever
          - limited_period
          example: null
        valid_from:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The date from which the coupon can be applied to subscriptions.
          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: |
            Status of the coupon.

            * future - The coupon is scheduled to start at a future date and cannot be applied to a subscription. From the valid_from date, the status changes to active.
            * expired -
              Cannot be applied to a subscription. A coupon may expire due to exceeding [max_redemptions](/docs/api/coupons/coupon-object#max_redemptions)
              or [valid_till](/docs/api/coupons/coupon-object#valid_till)
              date is past. Existing associations remain unaffected.
            * archived - Cannot be applied to a subscription. Existing associations remain unaffected.
            * active - Can be applied to a subscription.
            * deleted - Indicates the coupon has been deleted.
          enum:
          - active
          - expired
          - archived
          - deleted
          - future
          example: null
        apply_on:
          type: string
          deprecated: false
          description: |
            The amount on the invoice to which the coupon is applied.

            * invoice_amount -
              The coupon is applied to the invoice `sub_total`
              .
            * each_specified_item -
              Applies the coupon to specified items (plans, addons, or charges), with the discount applied to each matching `invoice.line_item.amount`.

              Requires applicability to be configured using [`item_constraints`](/docs/api/coupons/coupon-object#item_constraints)---for example `all`, `criteria`, or `specific` with `item_price_ids`.

              When you attach this coupon to a subscription, at least one of that subscription's plans, addons, or charges must match those rules. If none do, the request fails.
          enum:
          - invoice_amount
          - each_specified_item
          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: |
            The version number of this resource. For every change made to the resource, `resource_version`
            is updated with a new timestamp in milliseconds.
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this coupon was last updated.
            Note that this does not change when the [redemptions](/docs/api/coupons/coupon-object#redemptions)
            attribute is changed. This attribute will be present only if the resource has been updated after 2016-11-09.
          example: null
        period:
          type: integer
          format: int32
          deprecated: false
          description: |
            The duration of time for which the coupon is attached to the subscription, in `period_units`.
            Applicable only when [duration_type](/docs/api/coupons/coupon-object#duration_type)
            is [limited_period](/docs/api/coupons/coupon-object#duration_type)
            .
          minimum: 1
          example: null
        period_unit:
          type: string
          deprecated: false
          description: |
            The unit of time for period. Applicable only when [duration_type](/docs/api/coupons/coupon-object#duration_type)
            is [limited_period](/docs/api/coupons/coupon-object#duration_type)
            .

            * month - A period of 1 calendar month.
            * week - A period of 7 days.
            * year - A period of 1 calendar year.
            * day - A period of 24 hours.
          enum:
          - day
          - week
          - month
          - year
          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.  \n**Note:**\nThere's a character limit of 65,535.\n\
            \n[Learn more](/docs/api/advanced-features)\n.\n"
          example: null
        deleted:
          type: boolean
          deprecated: false
          description: |
            Indicates whether the coupon has been deleted or not.
          example: null
        item_constraints:
          type: array
          deprecated: false
          description: |
            The list of item constraints.
          items:
            type: object
            deprecated: false
            properties:
              item_type:
                type: string
                deprecated: false
                description: |
                  Item type for which this criteria is applicable for.

                  * charge - Charge
                  * plan - Plan
                  * addon - Addon
                enum:
                - plan
                - addon
                - charge
                example: null
              constraint:
                type: string
                deprecated: false
                description: |
                  Constraint applicable for the item

                  * specific - Coupon applicable to specific items.
                  * all - Coupon applicable to all items.
                  * criteria - Coupon applicable based on criteria.
                  * none - Coupon not applicable to any items.
                enum:
                - none
                - all
                - specific
                - criteria
                example: null
              item_price_ids:
                type: array
                deprecated: false
                description: |
                  List of item price ids for which this coupon is applicable.
                items:
                  example: null
                example: null
            required:
            - constraint
            - item_type
            example: null
          example: null
        item_constraint_criteria:
          type: array
          deprecated: false
          description: |
            The list of item constraint criteria.
          items:
            type: object
            deprecated: false
            properties:
              item_type:
                type: string
                deprecated: false
                description: |
                  Item type for which this criteria is applicable for.

                  * charge - Charge is a type of item
                  * plan - Plan is a type of item
                  * addon - Addon is a type of item
                enum:
                - plan
                - addon
                - charge
                example: null
              currencies:
                type: array
                deprecated: false
                description: |
                  List of currencies ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)
                  ) for which this coupon is applicable.
                items:
                  example: null
                example: null
              item_family_ids:
                type: array
                deprecated: false
                description: |
                  List of families for which this coupon is applicable.
                items:
                  example: null
                example: null
              item_price_periods:
                type: array
                deprecated: false
                description: |
                  List of frequencies for which this coupon is applicable. Allowed frequencies are \[day, week, month, year\].
                items:
                  example: null
                example: null
            required:
            - item_type
            example: null
          example: null
        coupon_constraints:
          type: array
          deprecated: false
          description: |
            List of constraints applicable on the redemption of this coupon.
          items:
            type: object
            deprecated: false
            properties:
              entity_type:
                type: string
                deprecated: false
                description: |
                  The resource type for the constraint. This, along with `type`
                  and `value`
                  , helps define the specific rule applied.

                  * customer -
                    The constraint is based on `customer`
                    records.
                enum:
                - customer
                example: null
              type:
                type: string
                deprecated: false
                description: |
                  Type of coupon constraints

                  * unique_by -
                    Indicates - when `entity_type`
                    is `customer`

                    * that the coupon can be redeemed only once for every unique value of a specified `customer` attribute. The `customer` attribute is specified using `value`. For example, if `value` is `email` , then the coupon can be redeemed only once for every unique value of `customer.email`. In other words, when there are multiple `customer` records with the same value for `email` , once the coupon has been redeemed for one of those customer records, no further redemptions of the coupon are allowed for any of those `customer` records.
                  * new_customer -
                    The coupon is applicable only for new customer(s). A customer will be considered as `new_customer`
                    when they do not have any prior non-void, non-zero-dollar invoices.
                  * existing_customer -
                    The coupon is applicable only for existing customer(s). A customer will be considered as `existing_customer`
                    when they have at least one non-void, non-zero-dollar invoice.
                  * max_redemptions -
                    The coupon can be redeemed up to a set number of times for a specific resource type. The maximum redemptions are specified using `value`
                    , and the resource type is specified using `entity_type`.
                    For example, if `entity_type`
                    is `customer`
                    and `value`
                    is `10`
                    then the coupon can only be redeemed up to 10 times for any particular `customer`
                    record.
                enum:
                - max_redemptions
                - unique_by
                - existing_customer
                - new_customer
                example: null
              value:
                type: string
                deprecated: false
                description: |+
                  The value of the coupon constraint. The possible values depend on the value of `constraints[type]`:

                  * When `type` is `unique_by`, then `value` can be `email` or `id`.

                  * When `type` is `max_redemptions`, then `value` can be any integer in the range `1` `coupon.max_redemptions`, inclusive.

                  * When type is `new_customer` or `existing_customer` then `value` can be `based_on_invoice`.

                maxLength: 65000
                example: null
            required:
            - entity_type
            - type
            example: null
          example: null
      required:
      - apply_on
      - created_at
      - deleted
      - discount_type
      - duration_type
      - id
      - name
      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.  \n**Note:**\nThere's a character limit of 65,535.\n\
            \n[Learn more](/docs/api/advanced-features)\n.\n"
          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: "A [Credit Note](https://www.chargebee.com/docs/credit-notes.html)\
        \ 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 'due' invoices.\n\n### Credit Note Types\n\nCredit notes in Chargebee\
        \ are categorized into three types:\n1. `adjustment`: Adjustment credit notes\
        \ are used to adjust the amount of an existing invoice in the `payment_due`\
        \ or `not_paid` [status](/docs/api/invoices/invoice-object#status). Use this\
        \ type of credit note to reduce the invoice amount, typically as a discount\
        \ to the customer.\n\nAdjustment credit notes are automatically created in\
        \ the following cases:\n\n* When an invoice is written off.\n* When a subscription\
        \ is modified with proration enabled, and the invoice for the current term\
        \ is in the `payment_due` or `not_paid` [status](/docs/api/invoices/invoice-object#status).\
        \ 2. `refundable`: Refundable credit notes allow you to return a certain amount\
        \ to the customer. These credits can be:\n* Retained for automatic application\
        \ on future invoices.\n* Applied to existing unpaid invoices.\n* Refunded\
        \ to the customer. Refundable credit notes are automatically created in the\
        \ following cases:\n* When an invoice is refunded.\n* When a subscription\
        \ is changed or canceled with proration enabled, the invoice for the current\
        \ term is in the `paid` [status](/docs/api/invoices/invoice-object#status).\
        \ Refundable credits are applied to future invoices or can be refunded to\
        \ the original payment method. 3. `store`: Store credit notes are created\
        \ for `paid` or `partially_paid` invoice [status](/docs/api/invoices/invoice-object#status)\
        \ during subscription changes, such as upgrades, downgrades, or cancellations.\
        \ Key characteristics of store credits:\n* No tax component is included at\
        \ the time of creation.\n* A credit note document is generated, similar to\
        \ refundable credits.\n* Store credits are applied before tax calculations\
        \ on future invoices.\n\n**Note:**\nIf you have enabled *consolidated invoicing*\n\
        , to know the subscriptions attached with a credit note you have to refer\
        \ [line_item's](/docs/api/credit_notes/credit_note-object#line_items)\n*subscription_id*\n\
        . The credit note's *subscription_id*\nshould **not**\nbe used (which will\
        \ be *null*\nif the credit note has lines from multiple subscriptions).  \n\
        Impact on reference invoice  \nThe following updates are made to the reference\
        \ invoice when a credit note is created/imported:\n\n* If the credit note\
        \ `type` is `adjustment`:\n  * The adjustment credit note details are added\
        \ to the `adjustment_credit_notes[]` attribute of the invoice.\n  * The invoice\
        \ `amount_due` is reduced by the credit note `total`.\n  * The invoice `status`\
        \ is updated to `paid` if the invoice `amount_due` equals the credit note\
        \ `total`.\n  * The invoice `status` does not change if the invoice `amount_due`\
        \ is greater than credit note `total`.\n* If the credit note `type` is `refundable`:\n\
        \  * The refundable credit note details are added to the `issued_credit_notes[]`\
        \ attribute of the invoice.\n  * The invoice `status` does not change.\n*\
        \ If the credit note `type` is `store`:\n  * The store credit note details\
        \ are added to the `issued_credit_notes[]` attribute of the invoice.\n  *\
        \ The invoice `status` does not change.\n"
      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/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: |
            Version number of this resource. The `resource_version`
            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.
          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\n* play_store -\n  The 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.  \n  In-App Subscriptions is currently in early\
            \ access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\n  for\
            \ more information.\n* web - The object was created (and is maintained)\
            \ for the web channel directly in Chargebee via API or UI.\n* app_store\
            \ -\n  The 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: "This attribute is returned only if additional resources are\
            \ available. Use this value as the input parameter for `line_items_offset`\
            \ to retrieve the next set of resources.  \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"
          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: |
            Invoice 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 invoice 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: |
            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 `round_off_amount`.
            If there is no `round-off amount`
            , it will display `0`
            .
          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
        notes:
          type: array
          deprecated: false
          description: |
            The list of notes attached to this credit note. Each note is displayed on customer-facing documents such as the [Credit Note PDF](/docs/api/credit_notes#retrieve_credit_note_as_pdf). Currently this list contains the note configured for the customer; additional note types may be added in future.
          items:
            type: string
            deprecated: false
            maxLength: 3500
            example: null
          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: |
            An overridden value for the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number).
            Only applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)

            `country`
            as `XI`
            (which is **United Kingdom - Northern Ireland**
            ).

            When you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)
            in 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)
            the Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)

            `country`
            as `XI`.
            That's the code for **United Kingdom - Northern Ireland** .
            The first two characters of the VAT number in such a case is
            `XI`
            by default. However, if the VAT number was registered in UK, the value should be `GB`.
            Set
            `vat_number_prefix`
            to `GB`
            for such cases.
          maxLength: 10
          example: null
        business_entity_id:
          type: string
          deprecated: false
          description: |
            The unique ID of the [business entity](/docs/api/advanced-features)
            of this credit_note. This is always the same as the business entity of the invoice referred to by [reference_invoice_id](/docs/api/credit_notes/credit_note-object#reference_invoice_id).
          maxLength: 50
          example: null
        brand_id:
          type: string
          deprecated: false
          description: |
            The unique ID of the [brand](/docs/api/brands) this credit note belongs to. This is always the same as the brand of the invoice referenced by `reference_invoice_id`. It cannot be set independently.
          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/invoices/invoice-object#line_items_quantity)
                  which is represented by this line item. For `metered`
                  line items, this value is updated from [usages](/docs/api/usages)
                  once when the invoice is generated as `pending`
                  and finally when the invoice is [closed](/docs/api/invoices/close-a-pending-invoice)
                  .
                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/2.0/plans.html#pricing-models)
                  for this item price.

                  * 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: |
                  The decimal representation of the unit amount of the `line_item`.
                  The value is in major units of the currency. Returned when the `line_item`
                  is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 39
                example: null
              quantity_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the quantity of this line_item. Returned when the `line_item`
                  is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 33
                example: null
              amount_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the amount for the `line_item`
                  , in major units of the currency. Typically equals to `unit_amount_in_decimal`
                  x `quantity_in_decimal`.
                  Returned when [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                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
                description: |
                  Indicates whether the line item is for a metered item. If `true`, the item is metered; otherwise, it is non-metered.
                example: null
              is_percentage_pricing:
                type: boolean
                deprecated: false
                description: |
                  Indicates whether the line item is percentage-based.
                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: 2000
                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
                  * 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
                enum:
                - adhoc
                - plan_item_price
                - addon_item_price
                - charge_item_price
                example: null
              tax_exempt_reason:
                type: string
                deprecated: false
                description: |
                  The reason due to which the line item price/amount is exempted from tax.

                  * zero_value_item - 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.
                  * reverse_charge - If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only
                  * tax_not_configured - If tax is not enabled for the site
                  * high_value_physical_goods - 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
                  * tax_not_configured_external_provider - If the tax is not configured for the country in 3rd party tax provider.
                  * customer_exempt - If the Customer is marked as Tax exempt
                  * region_non_taxable - 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
                  * product_exempt - If the Plan or Addon is marked as Tax exempt
                  * zero_rated - If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item
                  * export -
                    You are not registered for tax in the customer's region. This is also the reason code when both `billing_address`
                    and `shipping_address`
                    have not been provided for the customer and subscription respectively
                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
              proration_mode:
                type: string
                deprecated: false
                description: |
                  Proration mode for the line item.
                enum:
                - reset
                - delta
                - service_period_revision
                - adjusted_term
                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: |
                  The price of the tier if the charge model is a `stairtstep`
                  pricing , or the price of each unit in the tier if the charge model is `tiered`
                  /`volume`
                  pricing.
                minimum: 0
                example: null
              starting_unit_in_decimal:
                type: string
                deprecated: false
                description: |
                  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 `ending_unit_in_decimal`
                  of the next lower tier. Returned only when the `line_items.pricing_model`
                  is `tiered`
                  , `volume`
                  or `stairstep`
                  and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 33
                example: null
              ending_unit_in_decimal:
                type: string
                deprecated: false
                description: |
                  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 `starting_unit_in_decimal`
                  of the next higher tier. Returned only when the `line_items.pricing_model`
                  is `tiered`
                  , `volume`
                  or stairstep and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 33
                example: null
              quantity_used_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the quantity purchased from this tier. Returned when the `line_item`
                  is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 33
                example: null
              unit_amount_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the per-unit price for the tier when the `pricing_model`
                  is `tiered`
                  or `volume`.
                  When the `pricing_model`
                  is `stairstep`
                  , it is the decimal representation of the total price for `line_item`.
                  The value is in major units of the currency. Returned when the `line_item`
                  is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 40
                example: null
              pricing_type:
                type: string
                deprecated: false
                description: |
                  Pricing type for the tier.

                  * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                  * flat_fee -
                    Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                    pricing model, `pricing_type`
                    will be set to `flat_fee`
                    by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                  * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                enum:
                - per_unit
                - flat_fee
                - package
                example: null
              package_size:
                type: integer
                format: int32
                deprecated: false
                description: |
                  Package size for the tier when pricing type is `package`.
                  Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                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 credit note.
          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: |
                  The type of deduction and the amount to which it is applied.

                  * prorated_credits -
                    The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`
                    is `null`
                    in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)
                    .
                  * document_level_coupon -
                    The deduction is due to a coupon applied to the invoice `sub_total`.
                    The coupon `id`
                    is available as `entity_id`
                    .
                  * promotional_credits -
                    The deduction is due to a [promotional credit](/docs/api/promotional_credits)
                    applied to the invoice. The `entity_id`
                    is `null`
                    in this case.
                  * item_level_coupon -
                    The deduction is due to a coupon applied to a line item of the invoice. The coupon `id`
                    is available as `entity_id`
                    .
                  * document_level_discount -
                    The deduction is due to a [discount](/docs/api/discounts)
                    applied to the invoice `sub_total`.
                    The discount `id`
                    is available as the `entity_id`.
                  * item_level_discount -
                    The deduction is due to a [discount](/docs/api/discounts)
                    applied to a line item of the invoice. The discount `id`
                    is available as the `entity_id`.
                enum:
                - item_level_coupon
                - document_level_coupon
                - promotional_credits
                - prorated_credits
                - item_level_discount
                - document_level_discount
                example: null
              coupon_id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              entity_id:
                type: string
                deprecated: false
                description: |
                  When the deduction is due to a `coupon`
                  or a [discount](/docs/api/discounts)
                  , then this is the `id`
                  of the coupon or discount.
                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. This is set to the corresponding value on the invoice (`invoice.line_item_taxes[i].tax_amount`), prorated by the ratio of `credit_note.total` to `invoice.total`.
                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: |
                  The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
                  without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`
                  as `AZ`
                  (not `US-AZ`
                  ). For Tamil Nadu (India), set as `TN`
                  (not `IN-TN`
                  ). For British Columbia (Canada), set as `BC`
                  (not `CA-BC`
                  ).
                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: |
                  The unique id of the line item that this deduction is for. Is required when `discounts[entity_type]`
                  is `item_level_coupon`
                  or `document_level_coupon`
                  .
                maxLength: 40
                example: null
              entity_type:
                type: string
                deprecated: false
                description: |
                  The type of deduction and the amount to which it is applied.

                  * prorated_credits -
                    The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`
                    is `null`
                    in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)
                    .
                  * item_level_coupon -
                    The deduction is due to a coupon applied to line item. The coupon `id`
                    is passed as `entity_id`
                    .
                  * item_level_discount -
                    The deduction is due to a [discount](/docs/api/discounts)
                    applied to a line item of the invoice. The discount `id`
                    is available as the `entity_id`.
                  * document_level_coupon -
                    The deduction is due to a coupon applied to the invoice `sub_total`.
                    The coupon id is passed as `entity_id`
                    .
                  * promotional_credits -
                    The deduction is due to a [promotional credit](/docs/api/promotional_credits)
                    applied to the invoice.
                  * document_level_discount -
                    The deduction is due to a [discount](/docs/api/discounts)
                    applied to the invoice `sub_total`.
                    The discount `id`
                    is available as the `entity_id`.
                enum:
                - item_level_coupon
                - document_level_coupon
                - promotional_credits
                - prorated_credits
                - item_level_discount
                - document_level_discount
                example: null
              discount_type:
                type: string
                deprecated: false
                description: |
                  The type of discount that is applied to the line item. Relevant only when `discounts[entity_type]`
                  is one of `item_level_discount`
                  , `item_level_coupon`
                  , `document_level_discount`
                  , or `document_level_coupon`

                  * percentage - when percentage is applied as discount
                  * fixed_amount - when amount is applied as discount
                enum:
                - fixed_amount
                - percentage
                example: null
              entity_id:
                type: string
                deprecated: false
                description: |
                  When the deduction is due to a `coupon`
                  or a [discount](/docs/api/discounts)
                  , then this is the `id`
                  of the coupon or discount.
                maxLength: 100
                example: null
              coupon_set_code:
                type: string
                deprecated: false
                description: |
                  The [coupon code](/docs/api/coupon_codes/coupon_code-object#code)
                  , if applicable, used to provide the discount. The [coupon.id](/docs/api/coupons/coupon-object#id)
                  is available in `entity_id`
                  .
                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. This is set to the corresponding value on the invoice (`invoice.taxes[i].amount`), prorated by the ratio of `credit_note.total` to `invoice.total`.
                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: "The status of this transaction.\n\n* needs_attention\
                  \ -\n  When connection with the Gateway gets terminated abruptly.\
                  \ For `needs_attention`\n  status Chargebee automatically reconcile\
                  \ the transaction for few gateways, for rest of the gateways you\
                  \ have to use the [Reconcile transaction API](/docs/api/transactions/reconcile-transaction).\n\
                  \  You can use this API to update the `id_at_gateway`\n  (Gateway\
                  \ Transaction ID) and `status`\n  for a [`needs_attention`](/docs/api/transactions/transaction-object#status)\n\
                  \  transaction to be reconciled at par with the gateway.  \n  [Learn\
                  \ more](https://www.chargebee.com/docs/payments/2.0/needs-attention-transactions.html)\n\
                  \  about `needs_attention`\n  transaction status\n* voided - The\
                  \ transaction got voided or authorization expired at gateway.\n\
                  * late_failure - 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.\n* timeout - Transaction failed because\
                  \ of Gateway not accepting the connection.\n* success - The transaction\
                  \ is successful.\n* failure - Transaction failed. Refer the 'error_code'\
                  \ and 'error_text' fields to know the reason for failure\n* in_progress\
                  \ -\n  Transaction is being processed by the gateway. This typically\
                  \ happens for [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html)\n\
                  \  or, in case of cards, refund transactions. Such transactions\
                  \ can take 2-7 days to complete, depending on the gateway and payment\
                  \ method.\n"
                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: |
            The details of refunds recorded against the [invoice.linked_taxes_withheld](/docs/api/invoices/invoice-object#linked_taxes_withheld)
            component of the `invoice`
            [associated](/docs/api/credit_notes/credit_note-object#reference_invoice_id)
            with this `credit_note`.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  An auto-generated unique identifier for the tax withheld. The value starts with the prefix `tax_wh_`.
                  For example, `tax_wh_16BdDXSlbu4uV1Ee6`
                  .
                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: |
                  Current status of the invoice.

                  * not_paid - Indicates the payment is not made and all attempts to collect is failed.
                  * paid - Indicates a paid invoice.
                  * voided - Indicates a voided invoice.
                  * posted - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period
                  * pending -
                    The [invoice](/docs/api/invoices/invoice-object#status) is yet to be closed (sent for payment collection). An invoice is generated with this `status` when it has line items that belong to items that are `metered` or when the `subscription.create_pending_invoices`attribute is set to `true`.
                    The [invoice](/docs/api/v2/pcv-1/invoices/invoice-object#status) is yet to be closed (sent for payment collection). All invoices are generated with this `status` when [Metered Billing](https://www.chargebee.com/docs/1.0/metered_billing.html) is enabled for the site.
                  * payment_due - Indicates the payment is not yet collected and is being retried as per retry settings.
                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
        exchange_rates:
          type: array
          deprecated: false
          description: |
            List of exchange rates applied when converting credit note amounts to other currencies (such as VAT local currency and organization local currency). Each entry contains [`currency_code`](/docs/api/credit_notes/credit_note-object#exchange_rates_currency_code) and [`rate`](/docs/api/credit_notes/credit_note-object#exchange_rates_rate).

            The credit note currency is the base currency. When multiple rates target the same currency, only one entry is returned.

            This array is different from `exchange_rate` in the response. An entry whose `currency_code` matches [`local_currency_code`](/docs/api/credit_notes/credit_note-object#local_currency_code) uses the same rate as [`local_currency_exchange_rate`](/docs/api/credit_notes/credit_note-object#local_currency_exchange_rate).

            This array is returned in the response only when the corresponding features are enabled.
          items:
            type: object
            deprecated: false
            properties:
              currency_code:
                type: string
                deprecated: false
                description: |
                  Target currency for the conversion (ISO 4217). The credit note currency is the base currency.
                maxLength: 3
                example: null
              rate:
                type: number
                format: decimal
                deprecated: false
                description: |
                  Exchange rate applied as: 1 `currency_code` = `rate` credit note currency.

                  For example, when the credit note currency is `USD`, `currency_code` is `INR`, and `rate` is `0.010448403`, then 1 INR = 0.010448403 USD.
                maximum: 1000000000
                minimum: 0.0000000010
                example: null
            required:
            - currency_code
            - rate
            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: |
                The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
                without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`
                as `AZ`
                (not `US-AZ`
                ). For Tamil Nadu (India), set as `TN`
                (not `IN-TN`
                ). For British Columbia (Canada), set as `BC`
                (not `CA-BC`
                ).
              maxLength: 50
              example: null
            state:
              type: string
              deprecated: false
              description: |
                The state/province name.
              maxLength: 50
              example: null
            country:
              type: string
              deprecated: false
              description: "The billing address country of the customer. Must be one\
                \ of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                .\n\n**Note**:\nIf you enter an invalid country code, the system will\
                \ return an error.  \n**Brexit**\n\nIf you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                \ the Brexit configuration, then `XI` (the code for **United Kingdom\
                \ - Northern Ireland**) is available as an 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.
                * 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: |
                The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
                without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`
                as `AZ`
                (not `US-AZ`
                ). For Tamil Nadu (India), set as `TN`
                (not `IN-TN`
                ). For British Columbia (Canada), set as `BC`
                (not `CA-BC`
                ).
              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 country of the customer. Must be one\
                \ of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                .\n\n**Note**:\nIf you enter an invalid country code, the system will\
                \ return an error.  \n**Brexit**\n\nIf you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                \ the Brexit configuration, then `XI` (the code for **United Kingdom\
                \ - Northern Ireland**) is available as an 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.

                * 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: |
                The unique `id`
                for the e-invoice. This is auto-generated by Chargebee.
              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: |
                The status of processing the e-invoice. To obtain detailed information about the current `status`
                , see `message`
                .

                * message_acknowledgement - An acknowledgment confirming that the application response was successfully received 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.
                * 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.
                * scheduled - Sending the e-invoice to the customer has been scheduled.
                * paid - The receiving entity has confirmed that the e-invoice has been paid.
                * conditionally_accepted - The e-invoice has been accepted with conditions.
                * accepted - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.
                * skipped -
                  The e-invoice was not sent. This could be due to missing information or because the `entity_identifier`
                  is not registered on the e-invoicing network.
                * 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.
                * in_progress - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.
                * in_process - The e-invoice is currently being processed by the receiving entity.
                * registered - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.
              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: |
                Detailed information about the status of the e-invoice. When `status`
                is `skipped`
                or `failed`
                , this contains the reason or error details. The following are some valid examples:

                * Invoice successfully sent to customer via the e-invoicing network 9090:123456
                * Invoice successfully sent to customer via email id abc@acme.com
              maxLength: 3000
              example: null
            provider_references:
              type: array
              deprecated: false
              description: |
                List of key-value pairs from the e-invoicing provider (e.g. Receipt Message ID).
              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. Includes `currency_code` (ISO 4217): the currency of the organisation address country at creation time.
              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: 2000
                example: null
              entity_type:
                type: string
                deprecated: false
                enum:
                - adhoc
                - plan_item_price
                - addon_item_price
                - charge_item_price
                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
              proration_mode:
                type: string
                deprecated: false
                enum:
                - reset
                - delta
                - service_period_revision
                - adjusted_term
                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
                - item_level_discount
                - document_level_discount
                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
                - item_level_discount
                - document_level_discount
                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
      - consumption_based
      example: null
    CreditType:
      type: string
      default: general
      deprecated: false
      enum:
      - loyalty_credits
      - referral_rewards
      - general
      example: null
    CreditUnit:
      type: object
      description: |
        Credit units power credit-based billing for usage-based products, letting you get paid upfront while customers spend credits as they use your product's features. Each credit unit is a customizable consumption unit, such as AI credits or API calls, that you define beyond Chargebee's built-in pricing dimensions.

        When should you use credit units?
        ---------------------------------

        Credit units are a good fit when:

        * Customers have widely varying usage patterns
        * Business costs scale with consumption
        * Upfront cash flow is preferred

        How does it work?
        -----------------

        1. Create a credit unit (say, "AI Credits")
        2. Configure credit grants on your plans (e.g., a Pro Plan priced at $20 USD includes 100 AI Credits)
        3. Track customer usage in real time
        4. Bill for actual consumption

        **What happens when credits are exhausted?**

        Once the provisioned credits are exhausted, further consumption draws from the overdraft balance up to its configured limit. Configure overdraft behavior for a credit unit using [**is_unlimited**](#is_unlimited) and [**overdraft_amount**](#overdraft_amount), so customers can continue consuming, purchase more, or pay for overage depending on your setup.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            A unique and immutable identifier for the credit unit.
          maxLength: 50
          example: null
        name:
          type: string
          deprecated: false
          description: |
            Internal display name for the credit unit. This must be unique across the site.
          maxLength: 50
          example: null
        external_name:
          type: string
          deprecated: false
          description: |
            Customer-facing display name for the credit unit. This must be unique across the site.
            If not provided during creation, `name` is used as the default.
          maxLength: 50
          example: null
        status:
          type: string
          deprecated: false
          description: |
            The current lifecycle status of the credit unit.

            * active - Grant configuration for items and grant configuration overrides at subscription layer can be created for active credit units.
            * archived - Grant configuration for items and grant configuration overrides at subscription layer cannot be created for archived credit units. Already configured grants for credit units continue to be effective.
          enum:
          - active
          - archived
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            The version number of this resource. For every change made to the resource, `resource_version`
            is updated with a new timestamp in milliseconds.
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The time at which the credit unit was last updated.
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The time at which the credit unit was created.
          example: null
        created_by:
          type: string
          deprecated: false
          description: |
            The source (or the user) from where the credit unit has been created.
          maxLength: 100
          example: null
        updated_by:
          type: string
          deprecated: false
          description: |
            The source (or the user) from where the credit unit has been last updated.
          maxLength: 100
          example: null
        is_unlimited:
          type: boolean
          deprecated: false
          description: |
            Indicates whether this credit unit allows unlimited overdraft consumption. When `true`, grace consumption continues without a cap after the allocated grants are exhausted. When `false`, grace consumption is capped by `overdraft_amount`.
          example: null
        overdraft_amount:
          type: string
          deprecated: false
          description: |
            The amount up to which grace consumption is allowed after the allocated grants are exhausted. A positive decimal value that applies only when `is_unlimited` is `false`.
          maxLength: 50
          example: null
      required:
      - created_at
      - external_name
      - id
      - is_unlimited
      - name
      example: null
    Criteria:
      type: object
      properties: {}
      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: "Chargebee'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 [documentation](https://www.chargebee.com/docs/2.0/multi-currency-pricing.html)\
        \ to understand the multi-currency feature in Chargebee.\n\nThis currency\
        \ resource contains exchange rate configurations associated with a specific\
        \ currency. The multi-currency feature must be [enabled](https://www.chargebee.com/docs/2.0/multi-currency-pricing.html#1-adding-and-managing-currencies),\
        \ and all prerequisites must be addressed to successfully add a new currency\
        \ via the API.\n\nTo 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 [100 currencies](https://www.chargebee.com/docs/2.0/supported-currencies.html).\n\
        \nOn 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.\n\nCurrency values\n---------------\n\nBy default, the Chargebee\
        \ API supports only whole numbers for currency values. To allow for fractional\
        \ (decimal) values, you must enable the [multi-decimal pricing](https://www.chargebee.com/docs/2.0/multi-decimal-support.html)\
        \ 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.\n\n### Whole number currency values\n\nBy 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 \"in cents\" in this documentation.\n\nThe specific unit used for the\
        \ currency in the API depends on whether it is a zero-decimal currency:\n\n\
        * **Zero-decimal currencies** : 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 [ISO 4217 code](https://www.iso.org/iso-4217-currency-codes.html).\
        \ For example, to specify an amount of JPY 15, set the amount as `15`.\n*\
        \ **Other currencies** : 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\
        \ `153`.\n\n### Fractional currency values\n\nWhen [multi-decimal pricing](https://www.chargebee.com/docs/multi-decimal-support.html#configuring-multi-decimal-support)\
        \ is enabled in Chargebee, you can work with fractional currency values using\
        \ dedicated API parameters and attributes of the `String` type. Usually, these\
        \ attributes and parameters have the suffix `_in_decimal` in their names.\
        \ The value is expressed in the major unit of the currency, which is the unit\
        \ represented by its [ISO 4217 code](https://www.iso.org/iso-4217-currency-codes.html).\
        \ For example, $1.6782 should be provided as `1.6782`. The maximum number\
        \ of decimal places supported by the API can be [configured](https://www.chargebee.com/docs/multi-decimal-support.html#configuring-multi-decimal-support)\
        \ in the admin console.\n\n**Note:** For **zero-decimal currencies**, such\
        \ as the Japanese Yen (JPY), decimal places are not allowed.\n\n#### Rounding\
        \ of invoice line item amounts\n\nWhile Chargebee supports multiple decimal\
        \ places for currency values, at the [invoice line item](/docs/api/invoices/invoice-object#line_items_amount)\n\
        -level, the `amount`\nattribute 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\n[ISO 4217 code](https://www.iso.org/iso-4217-currency-codes.html)\n\
        .\n\nThe rounding logic used is [ROUND_HALF_EVEN](https://docs.oracle.com/javase/7/docs/api/java/math/BigDecimal.html#ROUND_HALF_EVEN)\n\
        . For example, if the [quantity](/docs/api/invoices/invoice-object#line_items_quantity)\n\
        is 0.0765 and [unit_amount](/docs/api/invoices/invoice-object#line_items_unit_amount)\n\
        is $10.674, the line item [amount](/docs/api/invoices/invoice-object#line_items_amount)\n\
        is (0.0765 x $10.674) = $0.816561 and is rounded off to $0.82.\n\nMulti-currency\
        \ support\n----------------------\n\nBy default, Chargebee is able to process\
        \ transactions in only one currency. However, you can enable the [multi-currency](https://www.chargebee.com/docs/2.0/multi-currency-pricing.html)\
        \ feature to support more currencies. The first currency enabled in Chargebee\
        \ also becomes the \"base currency\" by default. If you have multiple currencies\
        \ enabled and want to change the base currency for your site, reach out to\
        \ [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 assistance.  \n**Warning**\n\nFor some API endpoints, the `currency_code`\
        \ parameter becomes *required* when the multi-currency feature is enabled.\
        \ Before enabling the feature for your site, ensure that you update your code\
        \ to provide the `currency_code` parameter when calling the endpoints listed\
        \ in the next section.\n\n### List of affected endpoints\n\nThe following\
        \ endpoints require the `currency_code`\nparameter to be passed when the multi-currency\
        \ feature has been enabled.\n\n* Customer-related endpoints\n\n* [Add promotional\
        \ credits for a customer](/docs/api/promotional_credits/add-promotional-credits)\n\
        * [Deduct promotional credits from a customer](/docs/api/promotional_credits/deduct-promotional-credits)\n\
        * [Set promotional credits for a customer](/docs/api/promotional_credits/set-promotional-credits)\n\
        * [Record an excess payment for a customer](/docs/api/customers/record-an-excess-payment-for-a-customer)\n\
        * Invoice-related endpoints\n\n* [Create an invoice](/docs/api/invoices/create-invoice-for-items-and-one-time-charges)\n\
        * Product catalog-related endpoints\n\n* [Create an item price](/docs/api/item_prices/create-an-item-price)\n\
        * [Create a coupon](/docs/api/coupons/create-a-coupon-for-items)\n"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Unique identifier of a currency.
          maxLength: 40
          example: null
        enabled:
          type: boolean
          default: true
          deprecated: false
          description: |
            This field mentions whether the foreign currency is active or archived. If the value is `false`
            the foreign currency is archived else it is active.
          example: null
        forex_type:
          type: string
          deprecated: false
          description: |
            This represents the exchange rate type set for the currency.

            * auto -
              If `forex_type`
              is `auto`
              , conversion rate will be auto updated by Chargebee every day with third party providers (using external currency conversion providers).
            * manual -
              If `forex_type`
              is `manual`
              , 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.
          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: |
            Check whether this is a base currency or not. The value of the attribute is `true`
            when the currency matches the site's base currency.
          example: null
        manual_exchange_rate:
          type: string
          deprecated: false
          description: |
            This attribute shows the exchange rate in decimal. When `forex_type`
            is `manual`
            you have to set the exchange rate for additional currencies in `manual_exchange_rate`
            field.
          maxLength: 20
          example: null
      required:
      - currency_code
      - enabled
      - id
      - is_base_currency
      example: null
    CustomDataSchema:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        display_name:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        entity_type:
          type: string
          deprecated: false
          enum:
          - customer
          - subscription
          - invoice
          - quote
          - credit_note
          - transaction
          - plan
          - addon
          - coupon
          - order
          - item_family
          - item
          - item_price
          - plan_item
          - addon_item
          - charge_item
          - plan_price
          - addon_price
          - charge_price
          - differential_price
          - attached_item
          - feature
          - subscription_entitlement
          - item_entitlement
          - business_entity
          - price_variant
          - 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
          - business_ruleset
          - alert_status
          - omnichannel_subscription_item_metric
          - price_ramp
          example: null
        schema_definition:
          type: string
          deprecated: false
          maxLength: 65532
          example: null
        status:
          type: string
          default: active
          deprecated: false
          enum:
          - active
          - archived
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        modified_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
      required:
      - created_at
      - display_name
      - entity_type
      - id
      - modified_at
      - schema_definition
      - status
      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.
            * omnichannel_one_time_order - Omnichannel one-time order entity.
            * subscription_entitlement - Subscription entitlement entity.
            * plan - Plan entity.
            * price_variant - Price variant entity.
            * sales_order - Sales order entity.
            * omnichannel_subscription_item_scheduled_change - Scheduled change for an omnichannel subscription item entity.
            * transaction - Transaction entity.
            * quote - Quote entity.
            * plan_price - Plan price entity.
            * customer - Customer entity.
            * business_rule - Business rule 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.
            * omnichannel_transaction - Omnichannel transaction entity.
            * item_entitlement - Item entitlement entity.
            * usage_file - Usage file entity.
            * addon_item - Addon item entity.
            * charge_price - Charge price entity.
            * item_family - Item family entity.
            * ruleset - Ruleset entity.
            * plan_item - Plan item entity.
            * order - Order entity.
            * item_price - Item price entity.
            * omnichannel_subscription - Omnichannel subscription entity.
            * omnichannel_subscription_item - Omnichannel subscription item entity.
            * omnichannel_one_time_order_item - Omnichannel one-time order item entity.
            * business_entity - Business entity.
            * recorded_purchase - Recorded purchase entity.
            * credit_note - Credit note entity.
          enum:
          - customer
          - subscription
          - invoice
          - quote
          - credit_note
          - transaction
          - plan
          - addon
          - coupon
          - order
          - item_family
          - item
          - item_price
          - plan_item
          - addon_item
          - charge_item
          - plan_price
          - addon_price
          - charge_price
          - differential_price
          - attached_item
          - feature
          - subscription_entitlement
          - item_entitlement
          - business_entity
          - price_variant
          - 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
          - business_ruleset
          - alert_status
          - omnichannel_subscription_item_metric
          - price_ramp
          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
    CustomPricingUnit:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        name:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        external_name:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        status:
          type: string
          deprecated: false
          enum:
          - active
          - archived
          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
        created_by:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        updated_by:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        is_unlimited:
          type: boolean
          deprecated: false
          example: null
        overdraft_amount:
          type: string
          deprecated: false
          maxLength: 50
          example: null
      required:
      - created_at
      - external_name
      - id
      - is_unlimited
      - name
      example: null
    Customer:
      type: object
      additionalProperties: true
      description: "Represents a customer, which can be an individual or organization\
        \ that subscribes to your products or services. The customer resource associates\
        \ with [subscriptions](/docs/api/subscriptions/subscription-object), [card\
        \ information](/docs/api/cards/card-object), and billing addresses. The customer\
        \ details include their ID, name, contact information, and any [custom attributes](/docs/api/advanced-features)\
        \ you'd like to associate with them.  \n**Breaking Change**:\n\n* [**Sites**](https://www.chargebee.com/docs/2.0/sites-intro.html)\
        \ **created before March 1, 2014** : [updating the card](/docs/api/cards/update-card-for-a-customer)\
        \ deletes the customer's `billing_address` and `vat_number` and replaces them\
        \ with values from the request.\n* **Sites created on or after March 1, 2014**\
        \ : updating the card doesn't change the `billing_address` and `vat_number`.\n"
      properties:
        id:
          type: string
          deprecated: false
          description: "The unique identifier of the `customer` resource. You have\
            \ the option to specify this value when creating a customer. If not specified,\
            \ Chargebee automatically generates a unique identifier.  \n**Tip**\n\
            When the `customer` resource is [transferred](/docs/api/business_entities/transfer-resources-to-another-business-entity)\
            \ to a different [business_entity](/docs/api/business_entities), Chargebee\
            \ assigns a new random identifier to the `id` attribute. The original\
            \ identifier is preserved for the transferred copy of the `customer` resource.\
            \ (See also: [Mechanics of business entity transfer](/docs/api/business_entities).)\n"
          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: |
            The VAT/tax registration number for the customer. For customers with [billing_address](/docs/api/customers/customer-object#billing_address)

            `country`
            as
            `XI`
            (which is **United Kingdom - Northern Ireland**
            ), the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number)
            can be overridden by setting
            [vat_number_prefix](/docs/api/customers/customer-object#vat_number_prefix)
            .
          maxLength: 20
          example: null
        auto_collection:
          type: string
          default: "on"
          deprecated: false
          description: "When the customer has a [payment_method](/docs/api/customers/customer-object#payment_method)\n\
            of `type`\n`card`\n, this attribute determines whether to automatically\
            \ charge the card whenever an invoice [status](/docs/api/invoices/invoice-object#status)\n\
            is `payment_due`\n.  \n**Note**\nThis setting can be [overridden](/docs/api/subscriptions/create-subscription-for-items#auto_collection)\
            \ for individual subscriptions of the customer.\n\n* on -\n  Chargebee\
            \ automatically charges the card for invoices that enter `payment_due`\n\
            \  `status`\n  .\n* off - Automatic charging is disabled; manual payment\
            \ is required for due invoices.\n"
          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 from [`invoice.date`](/docs/api/invoices/invoice-object#date) until payment for the invoice is due.
          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: |
            **Note**
            Applicable only when the customer's `billing_address.country` is New Zealand, Australia, or in the EU.

            When the customer uses a [card](/docs/api/payment_sources/payment_source-object#type) [payment source](/docs/api/customers/customer-object#primary_payment_source_id), this attribute specifies whether the country of the customer and the card issuer are the same.
            The following three location indicators are compared:

            * The card issuer's country.
            * The `billing_address.country`.
            * The country to which `created_from_ip` belongs.
            * When all three are the same, this attribute is set to true, otherwise it is set to false. When all three are the same, this attribute is set to `true`, otherwise it is set to `false`.
          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 when this customer record was created. It's mainly used for [referral integrations](https://www.chargebee.com/docs/marketing-integration-index.html) and validating VAT if the customer is in the EU or UK.
            Depending on the method used to create the customer record, the field is set as follows:

            * **API** : When creating the `customer` resource through the API, you must include the customer's IP address in a [custom HTTP request header](/docs/api/advanced-features) (`chargebee-request-origin-ip`) for Chargebee to capture it.
            * **Checkout** : For `customer` resources created through [Chargebee Checkout](https://www.chargebee.com/docs/2.0/hosted-checkout.html), Chargebee automatically captures the IP address of the customer.
            * **UI** : When [creating a `customer`](https://www.chargebee.com/docs/2.0/customers.html#creating-a-new-customer) resource via the Chargebee Billing UI, this field is not relevant and the value must be ignored.
          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: |
            Specifies if the customer is liable for tax

            * zero_rated - This option is available only when zero-rated customer taxability is enabled for the site and the site uses [Chargebee Taxes](https://www.chargebee.com/docs/tax.html); third-party tax providers and integrations are not supported. Otherwise taxable line items for the customer are taxed at 0%. These line items have `is_taxed` set to `true`, the tax rate and tax amount set to `0`, and `tax_exempt_reason` set to `zero_rated`. Unlike `exempt`, this option follows the taxable tax path at a zero rate.
            * taxable -
              Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html).
              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 -
              * Customer is exempted from tax. When using Chargebee's native [Taxes](https://www.chargebee.com/docs/tax.html) feature or when using the [TaxJar integration](https://www.chargebee.com/docs/taxjar.html), no other action is needed.
              * However, when using our [Avalara integration](https://www.chargebee.com/docs/avalara.html), optionally, specify `entity_code` or `exempt_number` attributes if you use Chargebee's [AvaTax for Sales](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption) or specify `exemption_details` attribute if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. Tax may still be applied by Avalara for certain values of `entity_code`/`exempt_number`/`exemption_details` based on the state/region/province of the taxable address.
          enum:
          - taxable
          - exempt
          - zero_rated
          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: |
            Version number of this resource. The `resource_version`
            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.
          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: "**Note**\nApplicable only when [Calendar Billing](https://www.chargebee.com/docs/billing/2.0/subscriptions/calendar-billing)\
            \ with support for customer-specific billing date is enabled and `billing_date_mode`\
            \ is `manually_set`.\n\nSpecifies the day of the month for subscription\
            \ renewals on month-based or year-based plans. Month-based and year-based\
            \ plans are `item_price`\nresources where the `item_type`\nis set to `plan`\n\
            and `period_unit`\nis set to `month`\nand `year`\nrespectively.  \n**Example**\n\
            \n* **Month-based subscriptions** : If `billing_date` is set to `15`,\
            \ month-based renewals occur on the 15th of the month. It's important\
            \ to note that if the value is set to `31`, renewals align with the last\
            \ day of the month. Additionally, in February, a `billing_date` of `29`,\
            \ `30`, or `31` aligns renewals for the last day of February.\n* **Year-based\
            \ subscriptions** : A `billing_date` of `15` and a `billing_month` of\
            \ `7` schedules the renewal on the 15th of July.\n"
          maximum: 31
          minimum: 1
          example: null
        billing_month:
          type: integer
          format: int32
          deprecated: false
          description: "**Note**\nApplicable only when [Calendar Billing](https://www.chargebee.com/docs/billing/2.0/subscriptions/calendar-billing)\
            \ with support for customer-specific billing date is enabled and `billing_date_mode`\
            \ is `manually_set`.\n\nSpecifies the renewal month for subscriptions\
            \ on year-based plans. Year-based plans are `item_price`\nresources where\
            \ `item_type`\nis set to `plan`\nand `period_unit`\nis set to `year`.\
            \  \n**Example**\nThe renewal date is 15th July when `billing_date` is\
            \ `15` and `billing_month` is `7`.\n"
          maximum: 12
          minimum: 1
          example: null
        billing_date_mode:
          type: string
          deprecated: false
          description: |
            **Note**
            Applicable only when [Calendar Billing](https://www.chargebee.com/docs/billing/2.0/subscriptions/calendar-billing) with support for customer-specific billing date is enabled and `billing_date_mode` is `manually_set`.

            Indicates whether this customer's `billing_date`
            and `billing_month`
            values can be changed via the [Change billing date API](/docs/api/customers/change-billing-date)
            .

            * manually_set -
              `billing_date`
              and `billing_month`
              can be adjusted via API.
            * using_defaults -
              `billing_date`
              and `billing_month`
              are fixed as per Chargebee [site settings](https://www.chargebee.com/docs/2.0/calendar-billing-config.html#configuring-calendar-billing_configuring-site-wide-billing)
              and not modifiable via API.
          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/billing/2.0/usage-based-billing/metered_billing#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\n* play_store -\n  The 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.  \n  In-App Subscriptions is currently in early\
            \ access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\n  for\
            \ more information.\n* web - The object was created (and is maintained)\
            \ for the web channel directly in Chargebee via API or UI.\n* app_store\
            \ -\n  The 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: "**Note** : Present only when the `customer` has been [transferred](/docs/api/business_entities/transfer-resources-to-another-business-entity)\
            \ between business entities.\n\nRepresents the `id` of the active version\
            \ of the `customer` resource.  \n**Tip** : If the `id` and `active_id`\
            \ of a `customer` resource are the same, this indicates that you are working\
            \ with the active version of that customer resource.\n"
          maxLength: 50
          example: null
        fraud_flag:
          type: string
          deprecated: false
          description: |
            Indicates whether or not the customer has been [identified as fraudulent](https://www.chargebee.com/docs/payments/2.0/fraud-management/chargebee-fraud-management).

            * 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: |
            The [identifier](/docs/api/payment_sources/payment_source-object#id)
            of the customer's [primary payment source](https://www.chargebee.com/docs/2.0/payment-method-overview.html#primary-and-backup-payment-methods)
          maxLength: 40
          example: null
        backup_payment_source_id:
          type: string
          deprecated: false
          description: |
            The [identifier](/docs/api/payment_sources/payment_source-object#id)
            of the customer's [backup payment source](https://www.chargebee.com/docs/2.0/payment-method-overview.html#primary-and-backup-payment-methods)
            .
          maxLength: 40
          example: null
        invoice_notes:
          type: string
          deprecated: false
          description: |
            A note for the customer that appears on all their invoice PDFs. This is one of [several 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 unique ID of the [business entity](/docs/api/advanced-features)
            of this subscription. This is always the same as the [business entity](/docs/api/subscriptions/subscription-object#customer_id)
            of the customer.
          maxLength: 50
          example: null
        preferred_currency_code:
          type: string
          deprecated: false
          description: |
            **Note**
            Applicable only when the [Multi-Currency](https://www.chargebee.com/docs/2.0/multi-currency-pricing.html) feature is enabled.

            Specifies the customer's preferred currency in [ISO 4217](https://www.chargebee.com/docs/supported-currencies.html)
            format.
          maxLength: 3
          example: null
        promotional_credits:
          type: integer
          format: int64
          deprecated: false
          description: |
            The balance of [promotional credits](/docs/api/promotional_credits)
            available to the 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. These\
            \ are automatically applied to new invoices subject to [limits set at\
            \ the site level](https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/credit-notes#credits-flexibility)\
            \ which can be overridden for subscriptions via [`subscription.billing_override`](/docs/api/subscriptions/subscription-object#billing_override).\
            \  \n**Constraints**\n\n* When [multiple currencies](https://www.chargebee.com/docs/billing/2.0/site-configuration/multi-currency-pricing)\
            \ are enabled, this value is the excess payments balance for the customer's\
            \ preferred currency. In other words, this value is the same as `balances[i].excess_payments`\
            \ where `balances[i].currency_code` is the same as the `preferred_currency_code`.\n"
          minimum: 0
          example: null
        is_einvoice_enabled:
          type: boolean
          deprecated: false
          description: "Determines whether the customer is e-invoiced. When set to\
            \ `true`\nor not set to any value, the customer is e-invoiced so long\
            \ as e-invoicing is enabled for their country (`billing_address.country`\n\
            ). When set to `false`\n, the customer is not e-invoiced even if e-invoicing\
            \ is enabled for their country.  \n**Tip:**\n\nIt 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.\n"
          example: null
        einvoicing_method:
          type: string
          deprecated: false
          description: |
            Determines whether to send e-invoice 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.  \n**Note:**\nThere's a character limit of 65,535.\n\
            \n[Learn more](/docs/api/advanced-features)\n.\n"
          example: null
        deleted:
          type: boolean
          deprecated: false
          description: |
            Indicates that this resource has been deleted when the value is `true`
            .
          example: null
        registered_for_gst:
          type: boolean
          deprecated: false
          description: |
            Confirms that a customer is registered under GST. If set to `true`
            then the [Reverse Charge Mechanism](https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism)
            is applicable. This field is applicable only when Australian GST is configured for your site.
          example: null
        consolidated_invoicing:
          type: boolean
          deprecated: false
          description: "Indicates whether invoices raised on the same day for the\
            \ `customer` are consolidated. When present, this value overrides the\
            \ default configuration at the [site-level](https://www.chargebee.com/docs/consolidated-invoicing.html#configuring-consolidated-invoicing).\
            \ This attribute is applicable only when [Consolidated Invoicing](https://www.chargebee.com/docs/consolidated-invoicing.html)\
            \ is enabled.  \n**Note:**\n\nAny invoices raised when a subscription\
            \ activates from `in_trial` or `future` `status`, are not consolidated\
            \ by default. [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 enable consolidation for such invoices.\n"
          example: null
        customer_type:
          type: string
          deprecated: false
          description: |
            **Note**
            Applicable only when the [Chargebee's AvaTax for Communications integration](https://www.chargebee.com/docs/avatax-for-communication.html) is enabled.

            Indicates the [Avalara customer type](https://developer.avalara.com/communications-integration/design-considerations/customer-type/)
            .

            * industrial - The customer is an industrial business.
            * residential - The customer is an individual user.
            * senior_citizen - The customer is an individual that meets the jurisdiction requirements to be considered a senior citizen and qualifies for tax breaks.
            * business - The customer represents a 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: |
            **Note**
            Applicable only when the [Chargebee's AvaTax for Communications integration](https://www.chargebee.com/docs/avatax-for-communication.html) is enabled.

            The [Avalara client profile ID](https://developer.avalara.com/communications/dev-guide_rest_v2/customizing-transactions/client-profiles/)
            assigned to the customer.
          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: |
            An overridden value for the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number).
            Only applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)

            `country`
            as `XI`
            (which is **United Kingdom - Northern Ireland**
            ).

            When you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)
            in 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)
            the Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)

            `country`
            as `XI`.
            That's the code for **United Kingdom - Northern Ireland** .
            The first two characters of the VAT number in such a case is
            `XI`
            by default. However, if the VAT number was registered in UK, the value should be `GB`.
            Set
            `vat_number_prefix`
            to `GB`
            for such cases.
          maxLength: 10
          example: null
        entity_identifier_scheme:
          type: string
          deprecated: false
          description: "The Peppol BIS scheme associated with the [vat_number](/docs/api/customers/customer-object#vat_number)\n\
            of the customer. This helps identify the specific type of customer entity.\
            \ For example, `DE:VAT`\nis used for a German business entity while `DE:LWID45`\n\
            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\
            \ `billing_address.country`.\nSee [list of possible values](https://www.chargebee.com/docs/e-invoicing.html#supported-countries)\n\
            .  \n**Tip:**\n\nIf there are additional entity identifiers for the customer\
            \ not associated with the `vat_number`, they can be provided as the `entity_identifiers[]`\
            \ array.\n"
          maxLength: 50
          example: null
        entity_identifier_standard:
          type: string
          default: iso6523-actorid-upis
          deprecated: false
          description: "The standard used for specifying the `entity_identifier_scheme`.\n\
            Currently only `iso6523-actorid-upis`\nis supported and is used by default\
            \ when not provided.  \n**Tip:**\n\nIf there are additional entity identifiers\
            \ for the customer not associated with the `vat_number`, they can be provided\
            \ as the `entity_identifiers[]` array.\n"
          maxLength: 50
          example: null
        brand_id:
          type: string
          deprecated: false
          description: |
            The unique ID of the [brand](/docs/api/brands) this customer belongs to. The brand is assigned when the customer is created. When none is specified, the customer is linked to the default brand defined for the site.
          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: |
                The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
                without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                as `AZ`
                (not `US-AZ`
                ). For Tamil Nadu (India), set as `TN`
                (not `IN-TN`
                ). For British Columbia (Canada), set as `BC`
                (not `CA-BC`
                ). For Dubai (UAE), set as `DU`
                (not `AE-DU`
                ).
              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 country of the customer. Must be one\
                \ of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                .\n\n**Note**:\nIf you enter an invalid country code, the system will\
                \ return an error.  \n**Brexit**\n\nIf you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                \ the Brexit configuration, then `XI` (the code for **United Kingdom\
                \ - Northern Ireland**) is available as an 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://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\n* grab_pay - Payments made via\
                \ GrabPay\n* go_pay - Payments made via GoPay\n* nequi - Payments\
                \ made via Nequi.\n* google_pay - Payments made via Google Pay.\n\
                * after_pay - Payments made via Afterpay\n* qpay - Payments made via\
                \ Qpay.\n* pix - Payments made via Pix\n* pay_by_bank - Pay By Bank\n\
                * sofort - Payments made via Sofort.\n* twint - Payments made via\
                \ Twint\n* netbanking_emandates - Netbanking (eMandates) Payments.\n\
                * apple_pay - Payments made via Apple Pay.\n* unionpay - Payments\
                \ made via UnionPay.\n* giropay - Payments made via giropay.\n* direct_debit\
                \ - Represents bank account for which the direct debit or ACH agreement/mandate\
                \ is created.\n* rakuten_pay - Payments made via Rakuten Pay.\n* ovo\
                \ - Payments made via OVO.\n* mercado_pago - Payments made via Mercado\
                \ Pago.\n* paypay - Payments made via PayPay\n* south_korean_cards\
                \ - Payments made via South Korean Cards\n* bancontact - Payments\
                \ made via Bancontact Card.\n* upi - UPI Payments.\n* revolut_pay\
                \ - Payments made via Revolut Pay.\n* stablecoin - Payments made via\
                \ Stablecoin.\n* alipay -\n  Payments made via Alipay.  \n  This payment\
                \ source is deprecated.\n* tamara - Payments made via Tamara.\n* payme\
                \ - Payments made via PayMe\n* pay_to - Payments made via PayTo\n\
                * pay_co - Payments made via PayCo\n* picpay - Payments made via PicPay.\n\
                * kakao_pay - Payments made via Kakao Pay.\n* fpx - Payments made\
                \ via FPX.\n* wechat_pay -\n  Payments made via WeChat Pay.  \n  This\
                \ payment source is deprecated.\n* sepa_instant_transfer - Payments\
                \ made via Sepa Instant Transfer\n* dotpay - Payments made via Dotpay.\n\
                * p24 - Payments made via Przelewy24 (P24).\n* klarna - Payments made\
                \ via Klarna.\n* paypal_express_checkout - Payments made via PayPal\
                \ Express Checkout.\n* ideal - Payments made via iDEAL.\n* affirm_pay\
                \ - Payments made via Affirm Pay.\n* electronic_payment_standard -\
                \ Electronic Payment Standard\n* generic - Payments made via Generic\
                \ Payment Method.\n* klarna_pay_now - Payments made via Klarna Pay\
                \ Now\n* faster_payments - Payments made via Faster Payments\n* thai_qr\
                \ - Payments made via Thai QR.\n* swish - Payments made via Swish\n\
                * venmo - Payments made via Venmo\n* payconiq_by_bancontact - Payments\
                \ made via Payconiq by Bancontact.\n* naver_pay - Payments made via\
                \ Naver Pay.\n* wero - Payments made via Wero.\n* touch_n_go - Payments\
                \ made via Touch 'n Go.\n* momo - Payments made via MoMo.\n* blik\
                \ - Payments made via BLIK.\n* dana - Payments made via Dana.\n* automated_bank_transfer\
                \ - Represents virtual bank account using which the payment will be\
                \ done.\n* amazon_payments - Payments made via Amazon Payments.\n\
                * gcash - Payments made via GCash.\n* card - Card based payment including\
                \ credit cards and debit cards. Details about the card can be obtained\
                \ from the card resource.\n* online_banking_poland - Payments made\
                \ via Online Banking Poland\n* nupay - Payments made via NuPay.\n\
                * trustly - Trustly\n* kbc_payment_button - KBC Payment Button\n*\
                \ alipay_hk - Payments made via Alipay HK.\n* cash_app_pay - Payments\
                \ 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
              - alipay_hk
              - paypay
              - gcash
              - south_korean_cards
              - paynow
              - bizum
              - promptpay
              - dana
              - touch_n_go
              - tamara
              - qpay
              - ovo
              - momo
              - mercado_pago
              - nequi
              - nupay
              - picpay
              - thai_qr
              - blik
              - fpx
              - wero
              - p24
              - affirm_pay
              - rakuten_pay
              example: null
            gateway:
              type: string
              deprecated: false
              description: "Name of the gateway the payment method is associated with.\n\
                \n* ecentric - Ecentric provides a seamless payment processing service\
                \ in South Africa specializing on omnichannel capabilities.\n* paypal_payflow_pro\
                \ - PayPal Payflow Pro is a payment gateway.\n* sage_pay - Sage Pay\
                \ is a payment gateway.\n* wepay - WePay is a payment gateway.\n*\
                \ wirecard - WireCard Account is a payment service provider.\n* ezidebit\
                \ -\n  Ezidebit is a payment gateway integration based in Australia\
                \ that supports automated direct debit, BPAY, and card payments for\
                \ businesses.  \n  Ezidebit is in beta.\n* moyasar - Moyasar is a\
                \ fully integrated online payment service that makes accepting payments\
                \ simple and secure.\n* migs - MasterCard Internet Gateway Service\
                \ payment gateway.\n* ebanx - EBANX is a payment gateway, enabling\
                \ businesses to accept diverse local payment methods from various\
                \ countries for increased market reach and conversion.\n* beanstream\
                \ - Bambora(formerly known as Beanstream) is a payment gateway.\n\
                * adyen - Adyen is a payment gateway.\n* payway - Payway is a payment\
                \ gateway that enables secure card and payment acceptance.\n* 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.\n* braintree - Braintree is a payment\
                \ gateway.\n* nmi - NMI is a payment gateway.\n* chargebee_payments\
                \ - Chargebee Payments gateway\n* bluepay - BluePay is a payment gateway.\n\
                * paypal - PayPal Commerce is a payment gateway.\n* jp_morgan - J.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).\n\
                * bank_of_america - Bank of America is a payment gateway.\n* paypal_pro\
                \ - PayPal Pro Account is a payment gateway.\n* eway_rapid - eWAY\
                \ Rapid is a payment gateway.\n* nuvei -\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.  \n\
                \  This 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 - Windcave\
                \ provides an end to end payment processing solution in ANZ and other\
                \ leading global markets.\n* dlocal - Dlocal provides payment solutions\
                \ for global commerce by accepting local payment methods.\n* moneris_us\
                \ - Moneris USA is a payment gateway.\n* exact - Exact Payments is\
                \ a payment gateway.\n* paypal_express_checkout - PayPal Express Checkout\
                \ is a payment gateway.\n* solidgate - Solidgate is a secure and reliable\
                \ payment processing solution that allows you to accept payments from\
                \ customers and is suitable for various types of businesses.\n* tco\
                \ - 2Checkout is a payment gateway.\n* pay_com - Pay.com provides\
                \ payment services focused on simplicity and hassle-free operations\
                \ for businesses of all sizes.\n* chargebee - Chargebee test gateway.\n\
                * stripe - Stripe is a payment gateway.\n* eway - eWAY Account is\
                \ a payment gateway.\n* authorize_net - Authorize.net is a payment\
                \ gateway\n* moneris - Moneris is a payment gateway.\n* worldpay -\
                \ WorldPay is a payment gateway\n* pin - Pin is a payment gateway\n\
                * gocardless - GoCardless is a payment service provider.\n* elavon\
                \ - Elavon Virtual Merchant is a payment solution.\n* cybersource\
                \ - CyberSource is a payment gateway.\n* deutsche_bank - Deutsche\
                \ Bank is the leading German bank with strong European roots and a\
                \ global network.\n* vantiv - Vantiv is a payment gateway.\n* amazon_payments\
                \ - Amazon Payments is a payment service provider.\n* global_payments\
                \ - Global Payments is a payment service provider.\n* first_data_global\
                \ - First Data Global Gateway Virtual Terminal Account\n* paystack\
                \ -\n  Paystack is a payment gateway for businesses in Africa. It\
                \ enables secure payment acceptance both online and offline.  \n \
                \ This 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 - Chase\
                \ Paymentech(Orbital) is a payment gateway.\n* checkout_com - Checkout.com\
                \ is a payment gateway.\n* quickbooks - Intuit QuickBooks Payments\
                \ gateway\n* mollie - Mollie is a payment gateway.\n* bluesnap - BlueSnap\
                \ is a payment gateway.\n* paymill - PAYMILL is a payment gateway.\n\
                * twikey - Twikey is a payment service provider that specializes in\
                \ processing direct debit payments across the EU.\n* ogone - Ingenico\
                \ ePayments (formerly known as Ogone) is a payment gateway.\n* not_applicable\
                \ - Indicates that payment gateway is not applicable for this resource.\n\
                * hdfc - HDFC Account is a payment gateway.\n* balanced_payments -\
                \ Balanced is a payment gateway\n* payu - PayU is a payment gateway\
                \ that enables secure card payment acceptance via PaymentsOS.\n* tempus\
                \ - Tempus Technologies is a payment gateway and payments technology\
                \ provider offering secure payment processing with point-to-point\
                \ encryption (P2PE) and tokenization.\n* ingenico_direct - Worldline\
                \ Online Payments is a payment gateway.\n* metrics_global - 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
              - payu
              - 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. These are automatically applied to new invoices subject to [limits set at the site level](https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/credit-notes#credits-flexibility) which can be overridden for subscriptions via [`subscription.billing_override`](/docs/api/subscriptions/subscription-object#billing_override).
                minimum: 0
                example: null
              refundable_credits:
                type: integer
                format: int64
                default: 0
                deprecated: false
                description: |
                  Refundable credits balance of this customer. These are automatically applied to new invoices subject to [limits set at the site level](https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/credit-notes#credits-flexibility) which can be overridden for subscriptions via [`subscription.billing_override`](/docs/api/subscriptions/subscription-object#billing_override).
                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
                description: |
                  The unique identifier of the [business entity](/docs/api/business_entities)
                  associated with this balance.
                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: |
            Each element of the `entity_identifiers[]`
            array identifies a specific customer entity with the e-invoicing system. If the customer has only one entity identifier whose `value`
            is the `vat_number`
            , then this array is not needed as the `scheme`
            can be provided via `entity_identifier_scheme`.
            This array holds any additional entity identifiers that the customer may have.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  The unique id for the `entity_identifier`
                  in Chargebee. When not provided, it is autogenerated.
                maxLength: 40
                example: null
              value:
                type: string
                deprecated: false
                description: "The value of the `entity_identifier`.\nThis identifies\
                  \ the customer entity on the Peppol network. For example: `10101010-STO-10`\n\
                  .  \n**Tip:**\n\nIf there is only one entity identifier for the\
                  \ customer and the value is the same as `vat_number`, then there\
                  \ is no need to provide the `entity_identifiers[]` array. See [description\
                  \ for `entity_identifiers[]`](/docs/api/customers/customer-object#entity_identifiers).\n"
                maxLength: 50
                example: null
              scheme:
                type: string
                deprecated: false
                description: "The Peppol BIS scheme associated with the [vat_number](/docs/api/customers/customer-object#vat_number)\n\
                  of the customer. This helps identify the specific type of customer\
                  \ entity. For example, `DE:VAT`\nis used for a German business entity\
                  \ while `DE:LWID45`\nis used for a German government entity. The\
                  \ value must be from the list of possible values and must correspond\
                  \ to the country provided under `billing_address.country`.\nSee\
                  \ [list of possible values](https://www.chargebee.com/docs/e-invoicing.html#supported-countries)\n\
                  .  \n**Tip:**\n\nIf there is only one entity identifier for the\
                  \ customer and the value is the same as `vat_number`, then there\
                  \ is no need to provide the `entity_identifiers[]` array. See [description\
                  \ for `entity_identifiers[]`](/docs/api/customers/customer-object#entity_identifiers).\n"
                maxLength: 50
                example: null
              standard:
                type: string
                default: iso6523-actorid-upis
                deprecated: false
                description: "The standard used for specifying the `entity_identifier`\n\
                  `scheme`.\nCurrently, only `iso6523-actorid-upis`\nis supported\
                  \ and is used by default when not provided.  \n**Tip:**\n\nIf there\
                  \ is only one entity identifier for the customer and the value is\
                  \ the same as `vat_number`, then there is no need to provide the\
                  \ `entity_identifiers[]` array. See [description for `entity_identifiers[]`](/docs/api/customers/customer-object#entity_identifiers).\n"
                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/account-hierarchy.html)
            relationship that the customer is part of.
          properties:
            parent_id:
              type: string
              deprecated: false
              description: |
                The `id`
                of the immediate parent of this customer under account hierarchy. If the customer is the root of the hierarchy, this attribute isn't returned.
              maxLength: 50
              example: null
            payment_owner_id:
              type: string
              deprecated: false
              description: |
                The `id`
                of the customer responsible for paying the invoices for this customer. This ID must match either this customer's ID or the `invoice_owner_id`
                .
              maxLength: 50
              example: null
            invoice_owner_id:
              type: string
              deprecated: false
              description: |
                The `id`
                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.
              maxLength: 50
              example: null
          required:
          - invoice_owner_id
          - payment_owner_id
          example: null
        parent_account_access:
          type: object
          deprecated: false
          description: |
            When the customer is part of an [account hierarchy](https://www.chargebee.com/docs/account-hierarchy.html), this attribute defines the level of access that the parent account has to the customer's information.
            **Note:**
            the 'parent' is the customer whose id is [payment_owner_id](/docs/api/customers/customer-object#relationship_payment_owner_id).
            However, if the `payment_owner_id`
            is the customer itself, then the parent is [parent_id](/docs/api/customers/customer-object#relationship_parent_id)
            .
          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/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
    CustomerBusinessEntityChangedEvent:
      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:
            business_entity_transfer:
              $ref: "#/components/schemas/BusinessEntityTransfer"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - business_entity_transfer
          - customer
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      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
    CustomerEntitlement:
      type: object
      description: |
        The `customer_entitlement` resource can be viewed as a subset of the [subscription_entitlement](/docs/api/subscription_entitlements) resource enhanced with the customer's ID. It is introduced to help [retrieve](/docs/api/customer_entitlements/list-customer-entitlements) all subscription entitlements for a specific customer.
      properties:
        customer_id:
          type: string
          deprecated: false
          description: |
            The unique identifier of the [customer](/docs/api/customers)
            to which this entitlement belongs.
          maxLength: 50
          example: null
        subscription_id:
          type: string
          deprecated: false
          description: |
            The unique identifier of the [subscription](/docs/api/subscriptions)
            to which this entitlement belongs.
          maxLength: 50
          example: null
        feature_id:
          type: string
          deprecated: false
          description: |
            The unique identifier of the [feature](/docs/api/features)
            towards which this subscription entitlement has been granted.
          maxLength: 50
          example: null
        value:
          type: string
          deprecated: false
          description: |
            The value denoting the effective entitlement level that the subscription has towards the feature.
          maxLength: 50
          example: null
        name:
          type: string
          deprecated: false
          description: |
            The display name for the entitlement level. The value is automatically generated based on `feature.type`:

            * When `feature.type` is `range` or `quantity`: the `name` is the space-separated concatenation of `value` and the pluralized form of `feature.unit`. For example, if `value` is `20` and `feature.unit` is `user`, then `name` becomes `20 users`.
            * When `feature.type` is `custom`, the `name` is the same as `value`.
            * When `feature.type` is `switch`: `name` is set to `Available` when `value` is `true`; it's set to `Not Available` when `value` is `false`.
          maxLength: 50
          example: null
        is_enabled:
          type: boolean
          deprecated: false
          description: "When `true`\n, indicates that the [subscription_entitlement](/docs/api/subscription_entitlements)\n\
            is enabled.  \n**See also** :\n[Enable or disable subscription entitlement](/docs/api/subscription_entitlements/enable-or-disable-subscription-entitlements).\n"
          example: null
      required:
      - customer_id
      - is_enabled
      example: null
    CustomerEntitlementsUpdatedEvent:
      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:
            impacted_customer:
              $ref: "#/components/schemas/ImpactedCustomer"
          required:
          - impacted_customer
          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
    DifferentialPrice:
      type: object
      description: "Differential pricing helps implement a pricing strategy for addons\
        \ and charges based on the plans they're purchased with. A differential price\
        \ a specific price for an addon- or charge-[item price](/docs/api/item_prices)\
        \ when purchased along with a particular plan.\n\nDifferential pricing for\
        \ addons\n-------------------------------\n\nConsider an addon called 24x7\
        \ Customer Support provided with a cloud storage service. You can configure\
        \ differential prices for each of the addon-item prices based on the plan\
        \ they are purchased with, as follows:  \n\n|---|-----------------------------------------------------|-----------------------------------------------|-----------------------------------------------------|\n\
        |   | **Addon item price**                                | **Price when applied\
        \ to *Standard*** **Plan** | **Price when applied to** ***Enterprise*** **Plan**\
        \ |\n| 1 | 24x7 Customer Support, USD, Monthly, Flat fee, $100 | $90     \
        \                                      | $150                            \
        \                    |\n| 2 | 24x7 Customer Support, USD, Yearly, Flat fee,\
        \ $1000 | $900                                          | $1500          \
        \                                     |\n\nDifferential pricing for charges\n\
        --------------------------------\n\nConsider a charge, called Setup fee, for\
        \ installing and configuring a cloud-based project management platform. There\
        \ are two modes in which you can set up differential pricing for a charge:\n\
        \n#### Mode A: One charge differential price per plan-item\n\nThis mode is\
        \ used to specify one differential price for the charge-item price per [plan-item](/docs/api/items)\
        \ it is applied to.  \n\n|-------------------------------|---------------------------------------------------|-----------------------------------------------------|\n\
        | **Charge-item price**         | **Price when applied to** ***Standard***\
        \ **plan** | **Price when applied to** ***Enterprise*** **plan** |\n| Setup\
        \ fee, USD, Flat fee $500 | $400                                         \
        \     | $700                                                |\n\n#### Mode\
        \ B: Multiple charge differential prices per plan item\n\nThis mode is used\
        \ to specify multiple differential prices for the charge per plan-item, based\
        \ on the plan period.  \n\n|-------------------------------|-------------------------------------------------------------|-----------------------------------------------------------|\n\
        | **Charge-item price**         | **Price when applied to** ***Standard***\
        \ **plan, 6 months** | **Price when applied to** ***Standard*** **plan, yearly**\
        \ |\n| Setup fee, USD, Flat fee $500 | $400                              \
        \                          | $300                                        \
        \              |\n\nIn the above example, even if the \"6 month\" or \"yearly\"\
        \ plan-item prices do not exist, the differential prices for the charge can\
        \ still be created. They take effect whenever the plan-item prices are eventually\
        \ created and used in subscriptions.\n"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            A unique and immutable ID for the differential price. It is auto-generated when the differential price is created.
          maxLength: 100
          example: null
        item_price_id:
          type: string
          deprecated: false
          description: |
            The ID of the item price (`addon`
            or `charge`
            ) whose price should change according to the plan-item it is applied to.
          maxLength: 100
          example: null
        parent_item_id:
          type: string
          deprecated: false
          description: |
            The ID of the plan-item, in relation to which, the differential pricing for the addon or charge is defined. For example, this would be the id of the *Standard*
            or *Enterprise*
            plans-items mentioned in the [examples above](/docs/api/differential_prices)
            .
          maxLength: 100
          example: null
        price:
          type: integer
          format: int64
          deprecated: false
          description: |
            The differential price. If the pricing model of the `item_price_id`
            is `tiered`
            , `volume`
            , or `stairstep`
            , pass `tiers`
            instead of this.
          minimum: 0
          example: null
        price_in_decimal:
          type: string
          deprecated: false
          description: |
            The price of the item when the pricing_model is `flat_fee`.
            When the pricing model is `per_unit`
            , 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 [multi-decimal pricing](/docs/api/currencies)
            is enabled.
          maxLength: 39
          example: null
        status:
          type: string
          deprecated: false
          description: |
            The item family state.

            * active - New items can be created with the item family.
            * deleted - No items allowed for the item family.
          enum:
          - active
          - deleted
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            Version number of this resource. The `resource_version`
            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.
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp when this differential price was last updated.
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp at which this differential price was created.
          example: null
        modified_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp at which this differential price was last modified.
          example: null
        currency_code:
          type: string
          deprecated: false
          description: |
            The currency code (ISO 4217 format) of the plan
          maxLength: 3
          example: null
        business_entity_id:
          type: string
          deprecated: false
          description: |
            The unique ID of the
            [business entity](/docs/api/getting-started)
            of this subscription. This is applicable only when multiple business entities have been created for the site. The value of this attribute indicates that the resource is specific to the given business entity.
          maxLength: 50
          example: null
        deleted:
          type: boolean
          deprecated: false
          description: |
            Indicates whether the differential price has been deleted or not.
          example: null
        tiers:
          type: array
          deprecated: false
          description: |
            List of quantity-based pricing tiers for the differential price. Applicable only for `tiered`
            , `volume`
            , and `stairstep`
            `pricing_model`
            s. The tiers are exactly the same as those set for the item price. Only the `price`
            attribute for the various tiers can be overridden for the differential price.
          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: |
                  The per-unit price for the tier when the `pricing_model`
                  is `tiered`
                  or `volume`
                  ; the total cost for the item price when the `pricing_model`
                  is `stairstep`.
                  The value is in the [minor unit of the currency](/docs/api/currencies)
                  .
                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
              pricing_type:
                type: string
                deprecated: false
                description: |
                  Pricing type for the tier.

                  * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                  * flat_fee -
                    Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                    pricing model, `pricing_type`
                    will be set to `flat_fee`
                    by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                  * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                enum:
                - per_unit
                - flat_fee
                - package
                example: null
              package_size:
                type: integer
                format: int32
                deprecated: false
                description: |
                  Package size for the tier when pricing type is `package`.
                  Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                minimum: 1
                example: null
            required:
            - price
            - starting_unit
            example: null
          example: null
        parent_periods:
          type: array
          deprecated: false
          description: |
            When `item_price_id`
            is a charge-item, you can specify the plan period for which the price applies. Although an array, currently you can specify only one period. In other words, only index `0`
            is allowed. Create another differential price to specify another period. Is permitted only when `item_price_id`
            is a charge-item.
          items:
            type: object
            deprecated: false
            properties:
              period_unit:
                type: string
                deprecated: false
                description: |
                  The unit of time for `period`
                  .

                  * week - A period of 7 days.
                  * year - A period of 1 calendar year.
                  * month - A period of 1 calendar month.
                  * day - A period of 24 hours.
                enum:
                - day
                - week
                - month
                - year
                example: null
              period:
                type: array
                deprecated: false
                description: |
                  The billing period of the plan in `period_unit`
                  s. For example, a 6 month plan has `period`
                  as 6 and `period_unit`
                  as `month`
                  .
                items:
                  example: null
                example: null
            required:
            - period_unit
            example: null
          example: null
      required:
      - created_at
      - currency_code
      - deleted
      - id
      - item_price_id
      - modified_at
      - parent_item_id
      example: null
    DifferentialPriceCreatedEvent:
      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:
            differential_price:
              $ref: "#/components/schemas/DifferentialPrice"
          required:
          - differential_price
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    DifferentialPriceDeletedEvent:
      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:
            differential_price:
              $ref: "#/components/schemas/DifferentialPrice"
          required:
          - differential_price
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    DifferentialPriceUpdatedEvent:
      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:
            differential_price:
              $ref: "#/components/schemas/DifferentialPrice"
          required:
          - differential_price
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    DirectDebitScheme:
      type: string
      deprecated: false
      enum:
      - ach
      - bacs
      - sepa_core
      - autogiro
      - becs
      - becs_nz
      - pad
      - not_applicable
      example: null
    Discount:
      type: object
      description: "A `discount`, just like [coupons](/docs/api/coupons), represents\
        \ a deduction from the amounts in an `invoice`. While coupons are typically\
        \ used by your customers, `discount`s can be directly applied to subscriptions\
        \ by your sales team while negotiating new deals or upgrades. If the negotiations\
        \ are on the price itself, the [price override](\nhttps://www.chargebee.com/docs/price-override.html#api)\
        \ feature helps adjust the price further.\n\nAlthough a `discount` appears\
        \ as a deduction on an invoice, it is applied to a `subscription` while creating\
        \ or updating the `subscription`. Every `discount` in Chargebee is attached\
        \ to only one `subscription`.  \n**Note:**\n\n* The sum of the line-item-level\
        \ and invoice-level coupons together for a subscription, cannot exceed 10.\n\
        * When discounts are enabled in Chargebee, the [multi-coupons feature](https://www.chargebee.com/docs/coupons.html#applying-multiple-coupons-to-a-subscription)\
        \ is automatically activated.\n\nAdding a discount\n-----------------\n\n\
        ### Subscriptions\n\nA `discount` can be added to a `subscription` by calling\
        \ either [Create subscription](/docs/api/subscriptions/create-subscription-for-items)\
        \ or [Update subscription](/docs/api/subscriptions/update-subscription-for-items).\
        \ Once added, the `discount` is applied to all subsequent invoices if `apply_on`\
        \ is set to `invoice_amount`. When `apply_on` = `specific_item_price`, the\
        \ discount is applied (as a `discount.line_item_discount`) in each invoice\
        \ of the subscription that contains the specified item.\n\n### Invoices\n\n\
        A `discount` can be added to an `invoice` using [Create invoice for items\
        \ and one-time charges](/docs/api/invoices/create-invoice-for-items-and-one-time-charges)\
        \ using the `discounts` parameter.\n\n### Quotes\n\nA `discount` can be added\
        \ to a `quote` using the following operations:\n\n* [Create a quote for new\
        \ subscription](/docs/api/quotes/create-a-quote-for-a-new-subscription-items)\n\
        * [Create a quote for updating a subscription](/docs/api/quotes/create-a-quote-for-update-subscription-items)\n\
        * [Create a quote for charge and charge item](/docs/api/quotes/create-a-quote-for-charge-and-charge-items)\n\
        * [Edit a quote for a new subscription](/docs/api/quotes/edit-create-subscription-quote-for-items)\n\
        * [Edit a quote for updating a subscription](/docs/api/quotes/edit-update-subscription-quote-for-items)\n\
        * [Edit a quote for charge items and charges](/docs/api/quotes/edit-quote-for-charge-items-and-charges)\n\
        \n### Estimates\n\nA discount can be added to an estimate using the following\
        \ endpoints:\n\n* [Estimate for creating a subscription.](/docs/api/estimates/estimate-for-creating-a-subscription)\n\
        * [Estimate for creating a customer and subscription](/docs/api/estimates/estimate-for-creating-a-customer-and-subscription)\n\
        * [Estimate for updating a subscription](/docs/api/estimates/estimate-for-updating-a-subscription)\n\
        \nRemoving a discount\n-------------------\n\n### Subscriptions\n\nA `discount`\
        \ can be removed by calling [Update subscription](/docs/api/subscriptions/update-subscription-for-items)\
        \ with the relevant `discounts[operation_type][]` set to `remove`. Also, discounts\
        \ that have `duration_type` as `one_time` or `limited_period` are removed\
        \ automatically upon expiry.\n\n### Quotes\n\nA discount can be removed from\
        \ a quote using the following operations:\n\n* [Edit a quote for a new subscription](/docs/api/quotes/edit-create-subscription-quote-for-items)\n\
        * [Edit a quote for updating a subscription](/docs/api/quotes/edit-update-subscription-quote-for-items)\n\
        \n### Estimates\n\nA discount can be removed from an estimate using the following\
        \ operation:\n\n* [Estimate for updating a subscription](/docs/api/estimates/estimate-for-updating-a-subscription)\n\
        \nListing discounts\n-----------------\n\nA discount is associated with exactly\
        \ one subscription. You can fetch all the discounts currently attached to\
        \ a subscription by calling the [List discounts for a subscription API](/docs/api/subscriptions/list-discounts-for-a-subscription)\
        \ or by passing `include_discounts` as `true` while creating, importing, updating\
        \ or retrieving a subscription.\n\nOrder of application of coupons and discounts\n\
        ---------------------------------------------\n\nWhen both [coupons](/docs/api/coupons)\
        \ and [discounts](/docs/api/discounts) are applied simultaneously to a [subscription](/docs/api/subscriptions)\
        \ or [one-time invoice](/docs/api/invoices/create-invoice-for-items-and-one-time-charges),\
        \ they're applied in the following order:  \n\n|----|---------------------------------------|-------------------------------------------------------------------------------------------|\n\
        |    | **Summary**                           | **Description**           \
        \                                                                |\n| 1  |\
        \ Line-level, fixed amount coupons      | `coupon` with `apply_on` = `each_specified_item`\
        \ and `discount_type` = `flat`             |\n| 2  | Line-level, fixed amount\
        \ discounts    | `discount` with `apply_on` = `specific_item_price` and `type`\
        \ = `fixed_amount`            |\n| 3  | Line-level, percentage coupons   \
        \     | `coupon` with `apply_on` = `each_specified_item` and `discount_type`\
        \ = `percentage`       |\n| 4  | Line-level, percentage discounts      | `discount`\
        \ with `apply_on` = `specific_item_price` and `type` = `percentage`      \
        \        |\n| 5  | Line-level, offer quantity coupons    | `coupon` with `apply_on`\
        \ = `each_specified_item` and `discount_type` = `offer_quantity`   |\n| 6\
        \  | Line-level, offer quantity discounts  | `discount` with `apply_on` =\
        \ `specific_item_price` and `discount_type` = `offer_quantity` |\n| 7  | Invoice-level,\
        \ fixed amount coupons   | `coupon` with `apply_on` = `invoice_amount` and\
        \ `discount_type` = `flat`                  |\n| 8  | Invoice-level, fixed\
        \ amount discounts | `discount` with `apply_on` = `invoice_amount` and `type`\
        \ = `fixed_amount`                 |\n| 9  | Invoice-level, percentage coupons\
        \     | `coupon` with `apply_on` = `invoice_amount` and `discount_type` =\
        \ `percentage`            |\n| 10 | Invoice-level, percentage discounts  \
        \ | `discount` with `apply_on` = `invoice_amount` and `type` = `percentage`\
        \                   |\n\nFor example, consider the following scenario:\n\n\
        A subscription is created with:\n\n* a plan price of $200 per month\n* an\
        \ addon price of $20 per month\n* a flat $5 invoice discount\n* a 1% off coupon\
        \ on the addon\n* a flat $2 coupon on the invoice\n\nThe above coupons and\
        \ discount are applied in the following order:  \n\n|---|---------------------------------------------|-----------------------------------------------|\n\
        |   | **Discount or coupon applied**              | **Subtotal at each step**\
        \                     |\n| 1 | Initial subtotal (plan price + addon price)\
        \ | $200 + $20 = $220                             |\n| 2 | 1% off coupon on\
        \ the addon                  | $200 + $(20 - 0.02) = $200 + $19.98 = $219.98\
        \ |\n| 3 | Flat $2 coupon on the invoice               | $219.98 - $2 = $217.98\
        \                        |\n| 4 | Flat $5 invoice discount               \
        \     | $217.98 - $5 = **$212.98**                    |\n\n"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            An immutable unique id for the discount. It is always auto-generated.
          maxLength: 50
          example: null
        invoice_name:
          type: string
          deprecated: false
          description: |
            The name of the discount as it should appear on customer-facing pages and documents such as [invoices](/docs/api/invoices)
            and [hosted pages](/docs/api/hosted_pages).
            This is auto-generated based on the `type`
            , `amount`
            , and `currency_code`
            of the discount. For example, it can be `10% off`
            or `10$ off`
            .
          maxLength: 100
          example: null
        type:
          type: string
          default: percentage
          deprecated: false
          description: |
            The type of discount.
            Possible value are:

            * percentage - The specified percentage will be given as discount.
            * fixed_amount - The specified amount will be given as discount.
            * offer_quantity -
              A specified number of units of the item price are offered for free. The number of free units is specified in [quantity](/docs/api/discounts).
              The `offer_quantity`
              option is valid only when [apply_on](/docs/api/discounts/discount-object#apply_on)
              is set to `each_specified_item`
              and the [pricing_model](/docs/api/item_prices/item_price-object#pricing_model)
              of the item price is `per_unit`
              .
          enum:
          - fixed_amount
          - percentage
          - offer_quantity
          example: null
        percentage:
          type: number
          format: double
          deprecated: false
          description: |
            The percentage of the original amount that should be deducted from it. Only applicable when `discount.type`
            is `percentage`.
          maximum: 100
          minimum: 0.01
          example: null
        amount:
          type: integer
          format: int64
          deprecated: false
          description: |
            The value of the discount. [The format of this value](/docs/api/currencies)
            depends on the kind of currency. This is only applicable when `discount.type`
            is `fixed_amount`.
          minimum: 0
          example: null
        quantity:
          type: integer
          format: int32
          deprecated: false
          description: |
            Specifies the number of free units provided for the item, without affecting the total quantity sold. This parameter is applicable only when `discount.type`
            is `offer_quantity`.
          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 discount. This is only applicable when `discount.type`
            is `fixed_amount`
            .
          maxLength: 3
          example: null
        duration_type:
          type: string
          default: forever
          deprecated: false
          description: |
            Specifies the time duration for which this discount is attached to the subscription.

            * forever -
              The discount is attached to the subscription and applied on the invoices till it is [explicitly removed](/docs/api/subscriptions/update-subscription-for-items#discounts_operation_type)
              .
            * 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 `period`
              and `period_unit`
              .
            * one_time -
              The discount stays attached to the subscription till it is applied on an invoice **once**.
              It is removed after that from the subscription.
          enum:
          - one_time
          - forever
          - limited_period
          example: null
        period:
          type: integer
          format: int32
          deprecated: false
          description: |
            The duration of time for which the discount is attached to the subscription, in `period_units`.
            Applicable only when `duration_type`
            is `limited_period`.
          minimum: 1
          example: null
        period_unit:
          type: string
          deprecated: false
          description: |
            The unit of time for `period`.
            Applicable only when `duration_type`
            is `limited_period`.

            * year - A period of 1 calendar year.
            * month - A period of 1 calendar month.
            * week - A period of 7 days.
            * day - A period of 24 hours.
          enum:
          - day
          - week
          - month
          - year
          example: null
        included_in_mrr:
          type: boolean
          deprecated: false
          description: |
            The discount is included in MRR calculations for your site. This attribute is only applicable when `duration_type`
            is `one_time`
            and when the [feature is enabled](https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation)
            in Chargebee. Also, If the [site-level setting](https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation)
            is to exclude one-time discounts from MRR calculations, this value is always returned `false`.
          example: null
        apply_on:
          type: string
          deprecated: false
          description: |
            The amount on the invoice to which the discount is applied.

            * invoice_amount -
              The discount is applied to the invoice `sub_total`
              .
            * specific_item_price -
              The discount is applied to the `invoice.line_item.amount`
              that corresponds to the item price specified by `item_price_id`
              .
          enum:
          - invoice_amount
          - specific_item_price
          example: null
        item_price_id:
          type: string
          deprecated: false
          description: |
            The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
            in the subscription to which the discount is to be applied. Relevant only when `apply_on`
            = `specific_item_price`.
          maxLength: 100
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this discount is created.
          example: null
        apply_till:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Specifies till when the limited period discount is applicable. This attribute will be sent in the response only for `limited_period`
            duration type discount.
          example: null
        applied_count:
          type: integer
          format: int32
          deprecated: false
          description: |
            Specifies the number of times the discount has been applied.
          example: null
        coupon_id:
          type: string
          deprecated: false
          description: "Used to uniquely identify the coupon in your website/application\
            \ and to integrate with Chargebee.  \n**Note:**\n\nWhen the coupon ID\
            \ contains a special character; for example: `#`, the API returns an error.\
            \ Make sure that you [encode](https://www.urlencoder.org/) the coupon\
            \ ID in the path parameter before making an API call.\n"
          maxLength: 100
          example: null
        index:
          type: integer
          format: int32
          deprecated: false
          description: |
            The index number of the subscription to which the item price is added. Provide a unique number between `0`
            and `4`
            (inclusive) for each subscription that is to be created.
          minimum: 0
          example: null
      required:
      - apply_on
      - coupon_id
      - created_at
      - duration_type
      - id
      - included_in_mrr
      - index
      - type
      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
    Dispute:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 150
          example: null
        customer_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        transaction_id:
          type: string
          deprecated: false
          maxLength: 40
          example: null
        gateway_account_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        id_at_gateway:
          type: string
          deprecated: false
          maxLength: 200
          example: null
        currency_code:
          type: string
          deprecated: false
          maxLength: 3
          example: null
        amount:
          type: integer
          format: int64
          deprecated: false
          minimum: 0
          example: null
        reason:
          type: string
          deprecated: false
          maxLength: 250
          example: null
        status:
          type: string
          deprecated: false
          enum:
          - initiated
          - funds_withdrawn
          - in_review
          - cancelled
          - lost
          - won
          example: null
        type:
          type: string
          deprecated: false
          enum:
          - chargeback
          - inquiry
          example: null
        is_partial_dispute:
          type: boolean
          default: false
          deprecated: false
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
      required:
      - amount
      - created_at
      - currency_code
      - customer_id
      - gateway_account_id
      - id
      - is_partial_dispute
      - status
      - transaction_id
      - type
      example: null
    Download:
      type: object
      description: |
        Requesting to download a file through this API will return the `download_url` attribute as the response. This attribute will contain a URL that will allow the requested content to be downloaded.
      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: |
            The time until which the `download_url`
            is valid.
          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
      - real_time_payments
      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
          - teapps
          - finvoice
          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
    EffectiveEntitlement:
      type: object
      properties: {}
      example: null
    EffectiveOnEvent:
      type: string
      deprecated: false
      enum:
      - subscription_renewal
      example: null
    Einvoice:
      type: object
      description: |
        An e-invoice record associated with an invoice or credit note. It includes processing status, provider references, nested artifacts (for example application responses), and related status messages.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            The unique `id` for the e-invoice. This is auto-generated by Chargebee.
          maxLength: 50
          example: null
        entity_type:
          type: string
          deprecated: false
          description: |
            The type of the parent document this e-invoice belongs to.

            * invoice - Invoice
            * credit_note - Credit note
          enum:
          - invoice
          - credit_note
          example: null
        entity_id:
          type: string
          deprecated: false
          description: |
            The unique id of the parent document this e-invoice belongs to. When `entity_type` is `invoice`, this is the invoice id; when `entity_type` is `credit_note`, this is the credit note id.
          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: |
            The status of processing the e-invoice. To obtain detailed information about the current `status`, see `message`.

            * message_acknowledgement - An acknowledgment confirming that the application response was successfully received by the receiving entity.
            * in_progress - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.
            * under_query - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.
            * 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.
            * success - The e-invoice has been successfully delivered to the customer.
            * 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.
            * in_process - The e-invoice is currently being processed by the receiving entity.
            * paid - The receiving entity has confirmed that the e-invoice has been paid.
            * skipped - The e-invoice was not sent. This could be due to missing information or because the `entity_identifier` is not registered on the e-invoicing network.
            * failed - The e-invoice was sent and there was an error due to which it was not delivered.
            * scheduled - Sending the e-invoice to the customer has been scheduled.
            * conditionally_accepted - The e-invoice has been accepted with conditions.
          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: |
            Detailed information about the status of the e-invoice. When `status` is `skipped` or `failed`, this contains the reason or error details. The following are some valid examples:

            * Invoice successfully sent to customer via the e-invoicing network 9090:123456
            * Invoice successfully sent to customer via email id abc@acme.com
          maxLength: 3000
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this e-invoice resource was created.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            Version number of this resource. The `resource_version` 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.
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this e-invoice was last updated. This attribute will be present only if the resource has been updated after 2016-09-28.
          example: null
        deleted:
          type: boolean
          deprecated: false
          description: |
            Indicates that this resource has been deleted.
          example: null
        provider_references:
          type: array
          deprecated: false
          description: |
            List of key-value pairs from the e-invoicing provider (for example, a Receipt Message ID).
          items:
            example: null
          example: null
        business_entity_id:
          type: string
          deprecated: false
          description: |
            The unique ID of the [business entity](/docs/api/advanced-features) of this e-invoice. Same as the business entity of the parent invoice or credit note.
          maxLength: 50
          example: null
        artifacts:
          type: array
          deprecated: false
          description: |
            List of e-invoice artifacts related to this e-invoice (for example application responses).
          items:
            type: object
            deprecated: false
            properties:
              artifact_type:
                type: string
                deprecated: false
                description: |
                  Type of artifact that is sent as e-invoice from Chargebee or received as a result of processing the primary e-invoice. Example: `APPLICATION_RESPONSE`.
                maxLength: 50
                example: null
              direction:
                type: string
                deprecated: false
                description: |
                  Indicates whether the artifact was sent or received.

                  * outbound - The artifact was generated by Chargebee and sent to an external e-invoicing provider/platform.
                  * inbound - The artifact was received by Chargebee from an external e-invoicing provider/platform.
                enum:
                - outbound
                - inbound
                example: null
              status:
                type: string
                deprecated: false
                description: |
                  Processing or business status of the artifact.

                  * skipped - The artifact was not sent. This could be due to missing information.
                  * scheduled - Sending the artifact has been scheduled.
                  * registered - The artifact was sent and there was an error due to which it was not delivered but got cleared in the IRP.
                  * success - The artifact has been successfully delivered.
                  * failed - The artifact was sent and there was an error due to which it was not delivered.
                  * in_progress - The artifact has been sent and Chargebee is waiting for confirmation from the receiving entity.
                enum:
                - scheduled
                - skipped
                - in_progress
                - success
                - failed
                - registered
                example: null
              code:
                type: string
                deprecated: false
                description: |
                  The code associated with the artifact corresponds to its relation to the primary e-invoice. For example, in an Application Response artifact, the code indicates whether the primary e-invoice is accepted or rejected.
                maxLength: 100
                example: null
              external_artifact_id:
                type: string
                deprecated: false
                description: |
                  The id of the artifact received from the external e-invoicing provider/platform when sent as e-invoice.
                maxLength: 100
                example: null
              created_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Timestamp indicating when this artifact was created.
                example: null
              resource_version:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Version number of this resource. The `resource_version` 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.
                example: null
              updated_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Timestamp indicating when this artifact was last updated. This attribute will be present only if the resource has been updated after 2016-09-28.
                example: null
              deleted:
                type: boolean
                deprecated: false
                description: |
                  Indicates that this resource has been deleted.
                example: null
            required:
            - artifact_type
            - created_at
            - deleted
            - direction
            - status
            example: null
          example: null
      required:
      - created_at
      - deleted
      - entity_id
      - entity_type
      - id
      - status
      example: null
    EinvoiceCreatedEvent:
      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:
            einvoice:
              $ref: "#/components/schemas/Einvoice"
          required:
          - einvoice
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    EinvoiceUpdatedEvent:
      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:
            einvoice:
              $ref: "#/components/schemas/Einvoice"
          required:
          - einvoice
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    EinvoicingMethod:
      type: string
      deprecated: false
      enum:
      - automatic
      - manual
      - site_default
      example: null
    EmailLog:
      type: object
      description: |
        Email logs represent emails sent through Chargebee notification APIs, including [send invoice email](/docs/api/invoices#send_invoice_email), [send credit note email](/docs/api/credit_notes#send_credit_note_email), and [send payment request email](/docs/api/customers#send_payment_request_email).

        These objects are returned in the async `result.email_logs` array when a send-email operation completes successfully. There is no standalone retrieve or list API for email logs.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Unique identifier of this email.
          maxLength: 40
          example: null
        template_name:
          type: string
          deprecated: false
          description: |
            Name of the notification / email template that was sent.
          maxLength: 100
          example: null
        from_address:
          type: string
          deprecated: false
          description: |
            The from email address used for this email.
          maxLength: 254
          example: null
        to_address:
          type: string
          deprecated: false
          description: |
            The recipient email address.
          maxLength: 254
          example: null
        subject:
          type: string
          deprecated: false
          description: |
            Subject line of the email.
          maxLength: 500
          example: null
        status:
          type: string
          deprecated: false
          description: |
            Status of the email send request.

            * failed - Sending the email failed.
            * deferred - The email was deferred.
            * succeeded - The email was sent successfully.
            * scheduled - The email has been scheduled for delivery.
          enum:
          - scheduled
          - rescheduled
          - succeeded
          - failed
          - deferred
          - delivered
          - opened
          - bounced
          - dropped
          example: null
        sent_on:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        customer_id:
          type: string
          deprecated: false
          description: |
            The unique identifier of the customer associated with this email.
          maxLength: 50
          example: null
        site_id:
          type: string
          deprecated: false
          maxLength: 60
          example: null
        business_entity_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        brand_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        error_message:
          type: string
          deprecated: false
          description: |
            Error message when the email could not be sent or was deferred.
          maxLength: 1500
          example: null
      required:
      - from_address
      - id
      - status
      - subject
      - to_address
      example: null
    EndScheduleOn:
      type: string
      deprecated: false
      enum:
      - after_number_of_intervals
      - specific_date
      - subscription_end
      example: null
    Entitlement:
      type: object
      description: |
        The entitlement resource establishes a connection between a [feature](/docs/api/features)
        and an [item](/docs/api/items)
        or an [item_price](/docs/api/item_prices)
        in Chargebee Billing. By defining this relationship, it specifies the scope of access or rights the item or item price has in relation to that particular feature.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            A unique identifier for the entitlement. This is auto-generated.
          maxLength: 100
          example: null
        entity_id:
          type: string
          deprecated: false
          description: |
            The unique identifier of the entity being granted entitlement to a specific `feature`.
          maxLength: 100
          example: null
        entity_type:
          type: string
          deprecated: false
          description: |
            The type of the entity that holds this entitlement.

            * plan - Indicates that the entity is an `item` with [type](/docs/api/items/item-object#type) set to `plan`.
            * addon - Indicates that the entity is an `item` with [type](/docs/api/items/item-object#type) set to `addon`.
            * addon_price - Indicates that the entity is an `item_price` associated with an `item` with [type](/docs/api/items/item-object#type) set to `addon`.
            * charge - Indicates that the entity is an `item` with [type](/docs/api/items/item-object#type) set to `charge`.
            * plan_price - Indicates that the entity is an `item_price` associated with an `item` of [type](/docs/api/items/item-object#type) `plan`.
          enum:
          - plan
          - addon
          - charge
          - plan_price
          - addon_price
          example: null
        feature_id:
          type: string
          deprecated: false
          description: |
            The unique identifier of the `feature` to which the entity gains entitlement.
          maxLength: 50
          example: null
        feature_name:
          type: string
          deprecated: false
          description: |
            The `name`
            of the feature associated with this entitlement.
          maxLength: 50
          example: null
        value:
          type: string
          deprecated: false
          description: |+
            The level of entitlement that the entity has towards the feature. The possible values depend on the value of `feature.type`
            :

            * When `feature.type` is `quantity` and:

            * If `feature.levels[is_unlimited]` is not `true` for any one of `feature.levels[]`, then the value can be any one of `feature.levels[value][]`.

            * If `feature.levels[is_unlimited]` is `true` for one of the `feature.levels[]`, then the value can be:

              * any one of `feature.levels[value][]`
              * or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.
            * When `type` is `range` and:

            * If `feature.levels[is_unlimited]` is not `true` for any one of `feature.levels[]`, then the value can be any whole number between `levels[value][0]` and `levels[value][1]` (inclusive).

            * If `feature.levels[is_unlimited]` is `true` for one of the `feature.levels[]`, then the value can be:

              * any whole number equal to or greater than `levels[value][0]`
              * or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.
            * When `type` is `custom`, then the value can be any one of `feature.levels[value][]`.

            * When `type` is `switch`, then the value is set as `available` or `true`.

          maxLength: 50
          example: null
        name:
          type: string
          deprecated: false
          description: |
            The display name for the entitlement level. The value is automatically generated based on `feature.type`:

            * When `feature.type` is `quantity` or `range`, the `name` is the space-separated concatenation of `value` and the plural form of `feature.unit`. For instance, if `value` is `20` and `feature.unit` is `user`, the `name` will be `20 users`.
            * When `feature.type` is `custom`, the `name` matches the `value`.
            * When `feature.type` is `switch`, the `name` is set to `Available` when `value` is `true`; it's set to `Not Available` when `value` is `false`.
          maxLength: 50
          example: null
      required:
      - id
      example: null
    EntitlementOverride:
      type: object
      description: "`subscriptions` inherit `entitlement`s from `item`s and/or `item\
        \ price`s that are in them. Even so, there are many reasons why you may want\
        \ to override the inherited entitlements on a subscription:\n\n* A customer\
        \ wants access to a `feature` that the `item`s on their `subscription` are\
        \ not entitled to.\n* A customer wants a higher `feature.level` without having\
        \ to pay more.\n* A customer does not want to see or access a `feature` because\
        \ it is irrelevant to them.\n* You offer customized `feature` bundles for\
        \ each `subscription` instead of grouping `feature`s into a product catalog\
        \ of `item`s.\n\nThis API helps you implement each of the above use cases,\
        \ offering a method to override the entitlements for a subscription at the\
        \ subscription, [item price](/docs/api/item_prices/item-price-object), or\
        \ [charge-item](/docs/api/items#charge-items-or-charges) level.  \n**`entitlement_override`\
        \ expiry**\n\nIf [expires_at](/docs/api/entitlement_overrides/entitlement_override-object#expires_at)\
        \ has been set, then the `entitlement_override` object is no longer returned\
        \ after `expires_at` has passed. The expiration of an `entitlement_override`\
        \ does not trigger any event immediately. However, after expiry, the `entitlement_override`\
        \ record gets deleted within 12 hours. This deletion triggers the `entitlement_overrides_auto_removed`\
        \ event which can be considered as a notification, albeit delayed, for one\
        \ or more `entitlement_overrides` having expired.\n"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Unique identifier for the entitlement override. This is always auto-generated.
          maxLength: 50
          example: null
        subscription_id:
          type: string
          deprecated: false
          description: |
            The `id` of the [subscription](/docs/api/subscriptions) to which this entitlement override belongs.
          maxLength: 50
          example: null
        entity_id:
          type: string
          deprecated: false
          description: |
            * When omitted, the entitlement override applies at the subscription level. See [subscription-level entitlement overrides](/docs/api/subscription_entitlements/subscription-entitlement-object#subscription-level-override).
            * When provided, this is the ID of the entity whose contribution to the subscription entitlement is overridden. If the entity is not yet part of the subscription, the override takes effect when the entity is added. See [entity-level entitlement overrides](/docs/api/subscription_entitlements/subscription-entitlement-object#entity-level-overrides).
          maxLength: 100
          example: null
        entity_type:
          type: string
          deprecated: false
          description: |
            The type of the entity at whose level the entitlement override is being set for the subscription.
          maxLength: 50
          example: null
        feature_id:
          type: string
          deprecated: false
          description: |
            The `id` of the `feature` for which the entitlement override is being set.
          maxLength: 50
          example: null
        feature_name:
          type: string
          deprecated: false
          description: |
            The `name`
            of the `feature`
            towards which this entitlement override has been granted.
          maxLength: 50
          example: null
        value:
          type: string
          deprecated: false
          description: |+
            The level of entitlement that the item has towards the feature. The possible values depend on the value of `feature.type`
            :

            * When `feature.type` is `quantity` and:

            * If `feature.levels[is_unlimited]` is not `true` for any one of `feature.levels[]`, then the value can be any one of `feature.levels[value][]`.

            * If `feature.levels[is_unlimited]` is `true` for one of the `feature.levels[]`, then the value can also be:

              * any one of `feature.levels[value][]`
              * or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.
            * When `type` is `range` and:

            * If `feature.levels[is_unlimited]` is not `true` for any one of `feature.levels[]`, then the value can be any whole number between `levels[value][0]` and `levels[value][1]` (inclusive).

            * If `feature.levels[is_unlimited]` is `true` for one of the `feature.levels[]`, then the value can be:

              * any whole number equal to or greater than `levels[value][0]`
              * or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.
            * When `type` is `custom`, then the value can be any one of `feature.levels[value][]`.

            * When `type` is `switch`, then the value is set as `true` if the feature is available; it is set as `false` when the feature is unavailable.

          maxLength: 50
          example: null
        name:
          type: string
          deprecated: false
          description: |
            The display name for the entitlement level. The default values are auto-generated based on `feature.type` as follows:

            * When `feature.type` is `quantity` or `range`, then `name` is the space-separated concatenation of `value` and the pluralized version of `feature.unit`. For example, if `value` is `20` and `feature.unit` is `user`, then `name` becomes `20 users`.
            * When `feature.type` is `custom`, then `name` is the same as `value`.
            * When `feature.type` is `switch`, the `name` is set to `Available` when `value` is `true`; it's set to `Not Available` when `value` is `false`.
          maxLength: 50
          example: null
        expires_at:
          type: integer
          format: unix-time
          deprecated: false
          description: "The expiry date for the `entitlement_override`. The `entitlement_override`\
            \ object is no longer returned after this date has passed.  \n\n**Constraints**\n\
            Applicable only for subscription-level entitlement overrides. i.e. Not\
            \ applicable when `entity_id` and `entity_type` are set.\n\n\n"
          example: null
        effective_from:
          type: integer
          format: unix-time
          deprecated: false
          description: "The starting date and time for the entitlement override. It\
            \ indicates when the override becomes effective.  \n\n**Constraints**\n\
            Applicable only for subscription-level entitlement overrides. i.e. Not\
            \ applicable when `entity_id` and `entity_type` are set.\n\n\n"
          example: null
        is_enabled:
          type: boolean
          deprecated: false
          description: |
            Indicates the feature availability.
          example: null
      required:
      - id
      - is_enabled
      example: null
    EntitlementOverrideType:
      type: string
      deprecated: true
      enum:
      - feature_entitlement
      - credit_unit_grant
      example: null
    EntitlementOverridesAutoRemovedEvent:
      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:
            feature:
              $ref: "#/components/schemas/Feature"
            metadata:
              $ref: "#/components/schemas/Metadata"
            impacted_item:
              $ref: "#/components/schemas/ImpactedItem"
            impacted_subscription:
              $ref: "#/components/schemas/ImpactedSubscription"
          required:
          - feature
          - impacted_item
          - impacted_subscription
          - metadata
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    EntitlementOverridesRemovedEvent:
      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:
            impacted_subscription:
              $ref: "#/components/schemas/ImpactedSubscription"
            metadata:
              $ref: "#/components/schemas/Metadata"
          required:
          - impacted_subscription
          - metadata
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    EntitlementOverridesUpdatedEvent:
      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:
            impacted_subscription:
              $ref: "#/components/schemas/ImpactedSubscription"
            metadata:
              $ref: "#/components/schemas/Metadata"
          required:
          - impacted_subscription
          - metadata
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    EntitlementSetting:
      type: object
      description: ""
      properties:
        name:
          type: string
          deprecated: false
          description: ""
          maxLength: 500
          example: null
        value:
          type: string
          deprecated: false
          description: ""
          maxLength: 500
          example: null
      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:
      - customer
      - subscription
      - coupon
      - plan_item_price
      - addon_item_price
      - charge_item_price
      - plan_price
      - addon_price
      - charge_price
      - invoice
      - quote
      - credit_note
      - transaction
      - plan
      - addon
      - order
      - item_family
      - item
      - item_price
      - plan_item
      - addon_item
      - charge_item
      - differential_price
      - attached_item
      - feature
      - subscription_entitlement
      - item_entitlement
      - business_entity
      - price_variant
      - 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
      - business_ruleset
      - alert_status
      - omnichannel_subscription_item_metric
      - price_ramp
      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/2.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/2.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/2.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/2.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: |
                    The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
                    without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`
                    as `AZ`
                    (not `US-AZ`
                    ). For Tamil Nadu (India), set as `TN`
                    (not `IN-TN`
                    ). For British Columbia (Canada), set as `BC`
                    (not `CA-BC`
                    ).
                  maxLength: 50
                  example: null
                state:
                  type: string
                  deprecated: false
                  description: |
                    The state/province name.
                  maxLength: 50
                  example: null
                country:
                  type: string
                  deprecated: false
                  description: "The billing address country of the customer. Must\
                    \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                    .\n\n**Note**:\nIf you enter an invalid country code, the system\
                    \ will return an error.  \n**Brexit**\n\nIf you have enabled [EU\
                    \ VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021 or\
                    \ later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                    \ the Brexit configuration, then `XI` (the code for **United Kingdom\
                    \ - Northern Ireland**) is available as an 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://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: |
                    Action to be taken when the contract term completes.

                    * renew -
                      * Contract term completes and a new contract term is started for the number of billing cycles specified in [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).
                      * The `action_at_term_end` for the new contract term is set to `renew`.
                    * evergreen - Contract term completes and the subscription renews.
                    * renew_once -
                      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 [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).

                      * The `action_at_term_end` for the new contract term is set to `cancel`.
                    * cancel - Contract term completes and subscription is canceled.
                  enum:
                  - renew
                  - evergreen
                  - cancel
                  - renew_once
                  example: null
                total_contract_value:
                  type: integer
                  format: int64
                  default: 0
                  deprecated: false
                  description: |
                    The sum of the [totals](/docs/api/invoices/invoice-object#total)
                    of all the invoices raised as part of the contract term. For `active`
                    contract terms, this is a predicted value. The value depends on the [type of currency](/docs/api/estimates).
                    If the subscription was [imported](/docs/api/estimates/estimate-for-creating-a-subscription)
                    with the contract term, then this value includes the value passed for `total_amount_raised`
                    .
                  minimum: 0
                  example: null
                total_contract_value_before_tax:
                  type: integer
                  format: int64
                  default: 0
                  deprecated: false
                  description: |
                    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 `total_amount_raised_before_tax`
                    is included in the calculation of the total contract value before tax. It's important to note that this value excludes any applicable taxes.
                  minimum: 0
                  example: null
                cancellation_cutoff_period:
                  type: integer
                  format: int32
                  deprecated: false
                  description: |
                    The number of days before [`contract_end`](/docs/api/contract_terms/contract_term-object#contract_end)
                    , 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.
                  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: |
                    The number of subscription billing cycles remaining after the current one for the contract term. This attribute is only returned for `active`
                    contract terms.
                  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: |
                  Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/2.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 -
                    The action [configured for the site](https://www.chargebee.com/docs/2.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
                    at the time when the trial ends, takes effect. This is the default value when `trial_end_action`
                    is **not**
                    defined for the plan.
                  * plan_default -
                    The action [configured for the site](https://www.chargebee.com/docs/2.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
                    at the time when the trial ends, takes effect. This is the default value when `trial_end_action`
                    is defined for the plan.
                  * cancel_subscription - The subscription cancels.
                  * activate_subscription - The subscription activates and charges are raised for non-metered items.
                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: |
                      The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
                      without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`
                      as `AZ`
                      (not `US-AZ`
                      ). For Tamil Nadu (India), set as `TN`
                      (not `IN-TN`
                      ). For British Columbia (Canada), set as `BC`
                      (not `CA-BC`
                      ).
                    maxLength: 50
                    example: null
                  state:
                    type: string
                    deprecated: false
                    description: |
                      The state/province name.
                    maxLength: 50
                    example: null
                  country:
                    type: string
                    deprecated: false
                    description: "The billing address country of the customer. Must\
                      \ be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                      .\n\n**Note**:\nIf you enter an invalid country code, the system\
                      \ will return an error.  \n**Brexit**\n\nIf you have enabled\
                      \ [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021\
                      \ or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                      \ the Brexit configuration, then `XI` (the code for **United\
                      \ Kingdom - Northern Ireland**) is available as an 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://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: |
                      Action to be taken when the contract term completes.

                      * cancel - Contract term completes and subscription is canceled.
                      * renew_once -
                        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 [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).

                        * The `action_at_term_end` for the new contract term is set to `cancel`.
                      * evergreen - Contract term completes and the subscription renews.
                      * renew -
                        * Contract term completes and a new contract term is started for the number of billing cycles specified in [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).
                        * The `action_at_term_end` for the new contract term is set to `renew`.
                    enum:
                    - renew
                    - evergreen
                    - cancel
                    - renew_once
                    example: null
                  total_contract_value:
                    type: integer
                    format: int64
                    default: 0
                    deprecated: false
                    description: |
                      The sum of the [totals](/docs/api/invoices/invoice-object#total)
                      of all the invoices raised as part of the contract term. For `active`
                      contract terms, this is a predicted value. The value depends on the [type of currency](/docs/api/estimates).
                      If the subscription was [imported](/docs/api/estimates/estimate-for-creating-a-subscription)
                      with the contract term, then this value includes the value passed for `total_amount_raised`
                      .
                    minimum: 0
                    example: null
                  total_contract_value_before_tax:
                    type: integer
                    format: int64
                    default: 0
                    deprecated: false
                    description: |
                      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 `total_amount_raised_before_tax`
                      is included in the calculation of the total contract value before tax. It's important to note that this value excludes any applicable taxes.
                    minimum: 0
                    example: null
                  cancellation_cutoff_period:
                    type: integer
                    format: int32
                    deprecated: false
                    description: |
                      The number of days before [`contract_end`](/docs/api/contract_terms/contract_term-object#contract_end)
                      , 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.
                    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: |
                      The number of subscription billing cycles remaining after the current one for the contract term. This attribute is only returned for `active`
                      contract terms.
                    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: "The details of the line items in this invoice estimate.\
                \  \n**Note**\n\nLine items that meet **both** the following conditions\
                \ are **not** returned:\n\n* The line item belongs to an item price\
                \ whose parent item is [metered](/docs/api/items/item-object#metered).\n\
                * The `line_item.amount` is `0`.\n"
              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)
                      which is represented by this line item. For `metered`
                      line items, this value is updated from [usages](/docs/api/usages)
                      once when the invoice is generated as `pending`
                      and finally when the invoice is [closed](/docs/api/invoices/close-a-pending-invoice)
                      .
                    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/2.0/plans.html#pricing-models)
                      for this item price.

                      * 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: |
                      The decimal representation of the unit amount of the `line_item`.
                      The value is in major units of the currency. Returned when the `line_item`
                      is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                      is enabled.
                    maxLength: 39
                    example: null
                  quantity_in_decimal:
                    type: string
                    deprecated: false
                    description: |
                      The decimal representation of the quantity of this line_item. Returned when the `line_item`
                      is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                      is enabled.
                    maxLength: 33
                    example: null
                  amount_in_decimal:
                    type: string
                    deprecated: false
                    description: |
                      The decimal representation of the amount for the `line_item`
                      , in major units of the currency. Typically equals to `unit_amount_in_decimal`
                      x `quantity_in_decimal`.
                      Returned when [multi-decimal pricing](/docs/api/currencies)
                      is enabled.
                    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
                    description: |
                      Specifies whether this line item belongs to a [metered item](/docs/api/items#metered).
                    example: null
                  is_percentage_pricing:
                    type: boolean
                    deprecated: false
                    description: |
                      Indicates whether the line item is percentage-based.
                    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: 2000
                    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
                      * 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:
                    - adhoc
                    - plan_item_price
                    - addon_item_price
                    - charge_item_price
                    example: null
                  tax_exempt_reason:
                    type: string
                    deprecated: false
                    description: |
                      The reason due to which the line item price/amount is exempted from tax.

                      * zero_value_item - 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.
                      * tax_not_configured_external_provider - If the tax is not configured for the country in 3rd party tax provider.
                      * reverse_charge - If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only
                      * region_non_taxable - 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
                      * tax_not_configured - If tax is not enabled for the site
                      * high_value_physical_goods - 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
                      * product_exempt - If the Plan or Addon is marked as Tax exempt
                      * zero_rated - If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item
                      * export -
                        You are not registered for tax in the customer's region. This is also the reason code when both `billing_address`
                        and `shipping_address`
                        have not been provided for the customer and subscription respectively
                      * customer_exempt - If the Customer is marked as Tax exempt
                    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
                  proration_mode:
                    type: string
                    deprecated: false
                    description: |
                      Proration mode for the line item.
                    enum:
                    - reset
                    - delta
                    - service_period_revision
                    - adjusted_term
                    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: |
                      The price of the tier if the charge model is a `stairtstep`
                      pricing , or the price of each unit in the tier if the charge model is `tiered`
                      /`volume`
                      pricing.
                    minimum: 0
                    example: null
                  starting_unit_in_decimal:
                    type: string
                    deprecated: false
                    description: |
                      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 `ending_unit_in_decimal`
                      of the next lower tier. Returned only when the `line_items.pricing_model`
                      is `tiered`
                      , `volume`
                      or `stairstep`
                      and [multi-decimal pricing](/docs/api/currencies)
                      is enabled.
                    maxLength: 33
                    example: null
                  ending_unit_in_decimal:
                    type: string
                    deprecated: false
                    description: |
                      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 `starting_unit_in_decimal`
                      of the next higher tier. Returned only when the `line_items.pricing_model`
                      is `tiered`
                      , `volume`
                      or stairstep and [multi-decimal pricing](/docs/api/currencies)
                      is enabled.
                    maxLength: 33
                    example: null
                  quantity_used_in_decimal:
                    type: string
                    deprecated: false
                    description: |
                      The decimal representation of the quantity purchased from this tier. Returned when the `line_item`
                      is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                      is enabled.
                    maxLength: 33
                    example: null
                  unit_amount_in_decimal:
                    type: string
                    deprecated: false
                    description: |
                      The decimal representation of the per-unit price for the tier when the `pricing_model`
                      is `tiered`
                      or `volume`.
                      When the `pricing_model`
                      is `stairstep`
                      , it is the decimal representation of the total price for `line_item`.
                      The value is in major units of the currency. Returned when the `line_item`
                      is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                      is enabled.
                    maxLength: 40
                    example: null
                  pricing_type:
                    type: string
                    deprecated: false
                    description: |
                      Pricing type for the tier.

                      * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                      * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                      * flat_fee -
                        Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                        pricing model, `pricing_type`
                        will be set to `flat_fee`
                        by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                    enum:
                    - per_unit
                    - flat_fee
                    - package
                    example: null
                  package_size:
                    type: integer
                    format: int32
                    deprecated: false
                    description: |
                      Package size for the tier when pricing type is `package`.
                      Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                    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: |
                      The type of deduction and the amount to which it is applied.

                      * promotional_credits -
                        The deduction is due to a [promotional credit](/docs/api/promotional_credits)
                        applied to the invoice. The `entity_id`
                        is `null`
                        in this case.
                      * item_level_coupon -
                        The deduction is due to a coupon applied to a line item of the invoice. The coupon `id`
                        is available as `entity_id`
                        .
                      * document_level_discount -
                        The deduction is due to a [discount](/docs/api/discounts)
                        applied to the invoice `sub_total`.
                        The discount `id`
                        is available as the `entity_id`.
                      * document_level_coupon -
                        The deduction is due to a coupon applied to the invoice `sub_total`.
                        The coupon `id`
                        is available as `entity_id`
                        .
                      * item_level_discount -
                        The deduction is due to a [discount](/docs/api/discounts)
                        applied to a line item of the invoice. The discount `id`
                        is available as the `entity_id`.
                      * prorated_credits -
                        The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`
                        is `null`
                        in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)
                        .
                    enum:
                    - item_level_coupon
                    - document_level_coupon
                    - promotional_credits
                    - prorated_credits
                    - item_level_discount
                    - document_level_discount
                    example: null
                  coupon_id:
                    type: string
                    deprecated: false
                    maxLength: 50
                    example: null
                  entity_id:
                    type: string
                    deprecated: false
                    description: |
                      When the deduction is due to a `coupon`
                      or a [discount](/docs/api/discounts)
                      , then this is the `id`
                      of the coupon or discount.
                    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: |
                      The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
                      without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`
                      as `AZ`
                      (not `US-AZ`
                      ). For Tamil Nadu (India), set as `TN`
                      (not `IN-TN`
                      ). For British Columbia (Canada), set as `BC`
                      (not `CA-BC`
                      ).
                    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: |
                      The unique id of the line item that this deduction is for. Is required when `discounts[entity_type]`
                      is `item_level_coupon`
                      or `document_level_coupon`
                      .
                    maxLength: 40
                    example: null
                  entity_type:
                    type: string
                    deprecated: false
                    description: |
                      The type of deduction and the amount to which it is applied.

                      * item_level_discount -
                        The deduction is due to a [discount](/docs/api/discounts)
                        applied to a line item of the invoice. The discount `id`
                        is available as the `entity_id`.
                      * item_level_coupon -
                        The deduction is due to a coupon applied to line item. The coupon `id`
                        is passed as `entity_id`
                        .
                      * prorated_credits -
                        The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`
                        is `null`
                        in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)
                        .
                      * document_level_coupon -
                        The deduction is due to a coupon applied to the invoice `sub_total`.
                        The coupon id is passed as `entity_id`
                        .
                      * document_level_discount -
                        The deduction is due to a [discount](/docs/api/discounts)
                        applied to the invoice `sub_total`.
                        The discount `id`
                        is available as the `entity_id`.
                      * promotional_credits -
                        The deduction is due to a [promotional credit](/docs/api/promotional_credits)
                        applied to the invoice.
                    enum:
                    - item_level_coupon
                    - document_level_coupon
                    - promotional_credits
                    - prorated_credits
                    - item_level_discount
                    - document_level_discount
                    example: null
                  discount_type:
                    type: string
                    deprecated: false
                    description: |
                      The type of discount that is applied to the line item. Relevant only when `discounts[entity_type]`
                      is one of `item_level_discount`
                      , `item_level_coupon`
                      , `document_level_discount`
                      , or `document_level_coupon`

                      * fixed_amount - when amount is applied as discount
                      * percentage - when percentage is applied as discount
                    enum:
                    - fixed_amount
                    - percentage
                    example: null
                  entity_id:
                    type: string
                    deprecated: false
                    description: |
                      When the deduction is due to a `coupon`
                      or a [discount](/docs/api/discounts)
                      , then this is the `id`
                      of the coupon or discount.
                    maxLength: 100
                    example: null
                  coupon_set_code:
                    type: string
                    deprecated: false
                    description: |
                      The [coupon code](/docs/api/coupon_codes/coupon_code-object#code)
                      , if applicable, used to provide the discount. The [coupon.id](/docs/api/coupons/coupon-object#id)
                      is available in `entity_id`
                      .
                    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: |
                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 `round_off_amount`.
                If there is no `round-off amount`
                , it will display `0`
                .
              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: "The details of the line items in this invoice estimate.\
                  \  \n**Note**\n\nLine items that meet **both** the following conditions\
                  \ are **not** returned:\n\n* The line item belongs to an item price\
                  \ whose parent item is [metered](/docs/api/items/item-object#metered).\n\
                  * The `line_item.amount` is `0`.\n"
                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)
                        which is represented by this line item. For `metered`
                        line items, this value is updated from [usages](/docs/api/usages)
                        once when the invoice is generated as `pending`
                        and finally when the invoice is [closed](/docs/api/invoices/close-a-pending-invoice)
                        .
                      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/2.0/plans.html#pricing-models)
                        for this item price.

                        * 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: |
                        The decimal representation of the unit amount of the `line_item`.
                        The value is in major units of the currency. Returned when the `line_item`
                        is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      maxLength: 39
                      example: null
                    quantity_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        The decimal representation of the quantity of this line_item. Returned when the `line_item`
                        is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      maxLength: 33
                      example: null
                    amount_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        The decimal representation of the amount for the `line_item`
                        , in major units of the currency. Typically equals to `unit_amount_in_decimal`
                        x `quantity_in_decimal`.
                        Returned when [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      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
                      description: |
                        Indicates whether the line item is for a metered item. If `true`, the item is metered; otherwise, it is non-metered.
                      example: null
                    is_percentage_pricing:
                      type: boolean
                      deprecated: false
                      description: |
                        Indicates whether the line item is percentage-based.
                      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: 2000
                      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
                        * adhoc - Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case
                      enum:
                      - adhoc
                      - plan_item_price
                      - addon_item_price
                      - charge_item_price
                      example: null
                    tax_exempt_reason:
                      type: string
                      deprecated: false
                      description: |
                        The reason due to which the line item price/amount is exempted from tax.

                        * export -
                          You are not registered for tax in the customer's region. This is also the reason code when both `billing_address`
                          and `shipping_address`
                          have not been provided for the customer and subscription respectively
                        * customer_exempt - If the Customer is marked as Tax exempt
                        * high_value_physical_goods - 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
                        * zero_rated - If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item
                        * tax_not_configured - If tax is not enabled for the site
                        * tax_not_configured_external_provider - If the tax is not configured for the country in 3rd party tax provider.
                        * region_non_taxable - 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
                        * reverse_charge - If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only
                        * product_exempt - If the Plan or Addon is marked as Tax exempt
                        * zero_value_item - 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.
                      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
                    proration_mode:
                      type: string
                      deprecated: false
                      description: |
                        Proration mode for the line item.
                      enum:
                      - reset
                      - delta
                      - service_period_revision
                      - adjusted_term
                      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: |
                        The price of the tier if the charge model is a `stairtstep`
                        pricing , or the price of each unit in the tier if the charge model is `tiered`
                        /`volume`
                        pricing.
                      minimum: 0
                      example: null
                    starting_unit_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the `line_items.pricing_model`
                        is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      maxLength: 33
                      example: null
                    ending_unit_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the `line_items.pricing_model`
                        is `tiered`
                        , `volume`
                        or stairstep and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      maxLength: 33
                      example: null
                    quantity_used_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        The decimal representation of the quantity purchased from this tier. Returned when the `line_item`
                        is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      maxLength: 33
                      example: null
                    unit_amount_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for `line_item`.
                        The value is in major units of the currency. Returned when the `line_item`
                        is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      maxLength: 40
                      example: null
                    pricing_type:
                      type: string
                      deprecated: false
                      description: |
                        Pricing type for the tier.

                        * flat_fee -
                          Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                          pricing model, `pricing_type`
                          will be set to `flat_fee`
                          by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                        * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                        * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                      enum:
                      - per_unit
                      - flat_fee
                      - package
                      example: null
                    package_size:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      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: |
                        The type of deduction and the amount to which it is applied.

                        * promotional_credits -
                          The deduction is due to a [promotional credit](/docs/api/promotional_credits)
                          applied to the invoice. The `entity_id`
                          is `null`
                          in this case.
                        * item_level_coupon -
                          The deduction is due to a coupon applied to a line item of the invoice. The coupon `id`
                          is available as `entity_id`
                          .
                        * item_level_discount -
                          The deduction is due to a [discount](/docs/api/discounts)
                          applied to a line item of the invoice. The discount `id`
                          is available as the `entity_id`.
                        * document_level_coupon -
                          The deduction is due to a coupon applied to the invoice `sub_total`.
                          The coupon `id`
                          is available as `entity_id`
                          .
                        * document_level_discount -
                          The deduction is due to a [discount](/docs/api/discounts)
                          applied to the invoice `sub_total`.
                          The discount `id`
                          is available as the `entity_id`.
                        * prorated_credits -
                          The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`
                          is `null`
                          in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)
                          .
                      enum:
                      - item_level_coupon
                      - document_level_coupon
                      - promotional_credits
                      - prorated_credits
                      - item_level_discount
                      - document_level_discount
                      example: null
                    coupon_id:
                      type: string
                      deprecated: false
                      maxLength: 50
                      example: null
                    entity_id:
                      type: string
                      deprecated: false
                      description: |
                        When the deduction is due to a `coupon`
                        or a [discount](/docs/api/discounts)
                        , then this is the `id`
                        of the coupon or discount.
                      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: |
                        The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
                        without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`
                        as `AZ`
                        (not `US-AZ`
                        ). For Tamil Nadu (India), set as `TN`
                        (not `IN-TN`
                        ). For British Columbia (Canada), set as `BC`
                        (not `CA-BC`
                        ).
                      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: |
                        The unique id of the line item that this deduction is for. Is required when `discounts[entity_type]`
                        is `item_level_coupon`
                        or `document_level_coupon`
                        .
                      maxLength: 40
                      example: null
                    entity_type:
                      type: string
                      deprecated: false
                      description: |
                        The type of deduction and the amount to which it is applied.

                        * prorated_credits -
                          The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`
                          is `null`
                          in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)
                          .
                        * document_level_discount -
                          The deduction is due to a [discount](/docs/api/discounts)
                          applied to the invoice `sub_total`.
                          The discount `id`
                          is available as the `entity_id`.
                        * item_level_discount -
                          The deduction is due to a [discount](/docs/api/discounts)
                          applied to a line item of the invoice. The discount `id`
                          is available as the `entity_id`.
                        * promotional_credits -
                          The deduction is due to a [promotional credit](/docs/api/promotional_credits)
                          applied to the invoice.
                        * item_level_coupon -
                          The deduction is due to a coupon applied to line item. The coupon `id`
                          is passed as `entity_id`
                          .
                        * document_level_coupon -
                          The deduction is due to a coupon applied to the invoice `sub_total`.
                          The coupon id is passed as `entity_id`
                          .
                      enum:
                      - item_level_coupon
                      - document_level_coupon
                      - promotional_credits
                      - prorated_credits
                      - item_level_discount
                      - document_level_discount
                      example: null
                    discount_type:
                      type: string
                      deprecated: false
                      description: |
                        The type of discount that is applied to the line item. Relevant only when `discounts[entity_type]`
                        is one of `item_level_discount`
                        , `item_level_coupon`
                        , `document_level_discount`
                        , or `document_level_coupon`

                        * percentage - when percentage is applied as discount
                        * fixed_amount - when amount is applied as discount
                      enum:
                      - fixed_amount
                      - percentage
                      example: null
                    entity_id:
                      type: string
                      deprecated: false
                      description: |
                        When the deduction is due to a `coupon`
                        or a [discount](/docs/api/discounts)
                        , then this is the `id`
                        of the coupon or discount.
                      maxLength: 100
                      example: null
                    coupon_set_code:
                      type: string
                      deprecated: false
                      description: |
                        The [coupon code](/docs/api/coupon_codes/coupon_code-object#code)
                        , if applicable, used to provide the discount. The [coupon.id](/docs/api/coupons/coupon-object#id)
                        is available in `entity_id`
                        .
                      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: |
                  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 `round_off_amount`.
                  If there is no `round-off amount`
                  , it will display `0`
                  .
                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`
            is used to hold the details related to payment schedules for an invoice. It will contain a list of `payment_schedules`
            resources.
          items:
            type: object
            deprecated: false
            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: |
                  The identifier of the `payment_schedule_scheme`
                  , used to create the payment schedules.
                maxLength: 40
                example: null
              entity_type:
                type: string
                deprecated: false
                description: |
                  Specifies the modeled entity that the payment schedule is based on.

                  * invoice - Represents an invoice.
                enum:
                - invoice
                example: null
              entity_id:
                type: string
                deprecated: false
                description: |
                  The identifier of the modeled entity that this payment schedule is based on.
                maxLength: 50
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  An amount that this payment schedule is able 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 schedule.
                      maxLength: 40
                      example: null
                    date:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        The date when this payment schedule is scheduled.
                      example: null
                    amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        The total maximum amount that this payment schedule is allowed to collect.
                      minimum: 0
                      example: null
                    scheduled_amount:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        The planned installment amount for this schedule entry. Since an estimate has not collected any payment yet, this is the same as `amount`.
                      minimum: 0
                      example: null
                    status:
                      type: string
                      deprecated: false
                      description: |
                        Defines the status of each payment schedule.

                        * paid - Indicates that the payment has been made.
                        * posted - Indicates that the payment is posted.
                        * payment_due - Indicates that the payment is due.
                      enum:
                      - posted
                      - payment_due
                      - paid
                      example: null
                  required:
                  - amount
                  - date
                  - id
                  - scheduled_amount
                  - 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: "The details of the line items in this invoice estimate.\
                \  \n**Note**\n\nLine items that meet **both** the following conditions\
                \ are **not** returned:\n\n* The line item belongs to an item price\
                \ whose parent item is [metered](/docs/api/items/item-object#metered).\n\
                * The `line_item.amount` is `0`.\n"
              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)
                      which is represented by this line item. For `metered`
                      line items, this value is updated from [usages](/docs/api/usages)
                      once when the invoice is generated as `pending`
                      and finally when the invoice is [closed](/docs/api/invoices/close-a-pending-invoice)
                      .
                    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/2.0/plans.html#pricing-models)
                      for this item price.

                      * 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: |
                      The decimal representation of the unit amount of the `line_item`.
                      The value is in major units of the currency. Returned when the `line_item`
                      is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                      is enabled.
                    maxLength: 39
                    example: null
                  quantity_in_decimal:
                    type: string
                    deprecated: false
                    description: |
                      The decimal representation of the quantity of this line_item. Returned when the `line_item`
                      is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                      is enabled.
                    maxLength: 33
                    example: null
                  amount_in_decimal:
                    type: string
                    deprecated: false
                    description: |
                      The decimal representation of the amount for the `line_item`
                      , in major units of the currency. Typically equals to `unit_amount_in_decimal`
                      x `quantity_in_decimal`.
                      Returned when [multi-decimal pricing](/docs/api/currencies)
                      is enabled.
                    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
                    description: |
                      Indicates whether the line item is for a metered item. If `true`, the item is metered; otherwise, it is non-metered.
                    example: null
                  is_percentage_pricing:
                    type: boolean
                    deprecated: false
                    description: |
                      Indicates whether the line item is percentage-based.
                    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: 2000
                    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
                      * 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:
                    - adhoc
                    - plan_item_price
                    - addon_item_price
                    - charge_item_price
                    example: null
                  tax_exempt_reason:
                    type: string
                    deprecated: false
                    description: |
                      The reason due to which the line item price/amount is exempted from tax.

                      * zero_value_item - 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.
                      * tax_not_configured_external_provider - If the tax is not configured for the country in 3rd party tax provider.
                      * zero_rated - If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item
                      * tax_not_configured - If tax is not enabled for the site
                      * high_value_physical_goods - 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
                      * customer_exempt - If the Customer is marked as Tax exempt
                      * export -
                        You are not registered for tax in the customer's region. This is also the reason code when both `billing_address`
                        and `shipping_address`
                        have not been provided for the customer and subscription respectively
                      * reverse_charge - If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only
                      * region_non_taxable - 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
                      * product_exempt - If the Plan or Addon is marked as Tax exempt
                    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
                  proration_mode:
                    type: string
                    deprecated: false
                    description: |
                      Proration mode for the line item.
                    enum:
                    - reset
                    - delta
                    - service_period_revision
                    - adjusted_term
                    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: |
                      The price of the tier if the charge model is a `stairtstep`
                      pricing , or the price of each unit in the tier if the charge model is `tiered`
                      /`volume`
                      pricing.
                    minimum: 0
                    example: null
                  starting_unit_in_decimal:
                    type: string
                    deprecated: false
                    description: |
                      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 `ending_unit_in_decimal`
                      of the next lower tier. Returned only when the `line_items.pricing_model`
                      is `tiered`
                      , `volume`
                      or `stairstep`
                      and [multi-decimal pricing](/docs/api/currencies)
                      is enabled.
                    maxLength: 33
                    example: null
                  ending_unit_in_decimal:
                    type: string
                    deprecated: false
                    description: |
                      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 `starting_unit_in_decimal`
                      of the next higher tier. Returned only when the `line_items.pricing_model`
                      is `tiered`
                      , `volume`
                      or stairstep and [multi-decimal pricing](/docs/api/currencies)
                      is enabled.
                    maxLength: 33
                    example: null
                  quantity_used_in_decimal:
                    type: string
                    deprecated: false
                    description: |
                      The decimal representation of the quantity purchased from this tier. Returned when the `line_item`
                      is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                      is enabled.
                    maxLength: 33
                    example: null
                  unit_amount_in_decimal:
                    type: string
                    deprecated: false
                    description: |
                      The decimal representation of the per-unit price for the tier when the `pricing_model`
                      is `tiered`
                      or `volume`.
                      When the `pricing_model`
                      is `stairstep`
                      , it is the decimal representation of the total price for `line_item`.
                      The value is in major units of the currency. Returned when the `line_item`
                      is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                      is enabled.
                    maxLength: 40
                    example: null
                  pricing_type:
                    type: string
                    deprecated: false
                    description: |
                      Pricing type for the tier.

                      * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                      * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                      * flat_fee -
                        Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                        pricing model, `pricing_type`
                        will be set to `flat_fee`
                        by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                    enum:
                    - per_unit
                    - flat_fee
                    - package
                    example: null
                  package_size:
                    type: integer
                    format: int32
                    deprecated: false
                    description: |
                      Package size for the tier when pricing type is `package`.
                      Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                    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: |
                      The type of deduction and the amount to which it is applied.

                      * item_level_coupon -
                        The deduction is due to a coupon applied to a line item of the invoice. The coupon `id`
                        is available as `entity_id`
                        .
                      * prorated_credits -
                        The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`
                        is `null`
                        in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)
                        .
                      * item_level_discount -
                        The deduction is due to a [discount](/docs/api/discounts)
                        applied to a line item of the invoice. The discount `id`
                        is available as the `entity_id`.
                      * document_level_coupon -
                        The deduction is due to a coupon applied to the invoice `sub_total`.
                        The coupon `id`
                        is available as `entity_id`
                        .
                      * promotional_credits -
                        The deduction is due to a [promotional credit](/docs/api/promotional_credits)
                        applied to the invoice. The `entity_id`
                        is `null`
                        in this case.
                      * document_level_discount -
                        The deduction is due to a [discount](/docs/api/discounts)
                        applied to the invoice `sub_total`.
                        The discount `id`
                        is available as the `entity_id`.
                    enum:
                    - item_level_coupon
                    - document_level_coupon
                    - promotional_credits
                    - prorated_credits
                    - item_level_discount
                    - document_level_discount
                    example: null
                  coupon_id:
                    type: string
                    deprecated: false
                    maxLength: 50
                    example: null
                  entity_id:
                    type: string
                    deprecated: false
                    description: |
                      When the deduction is due to a `coupon`
                      or a [discount](/docs/api/discounts)
                      , then this is the `id`
                      of the coupon or discount.
                    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: |
                      The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
                      without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`
                      as `AZ`
                      (not `US-AZ`
                      ). For Tamil Nadu (India), set as `TN`
                      (not `IN-TN`
                      ). For British Columbia (Canada), set as `BC`
                      (not `CA-BC`
                      ).
                    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: |
                      The unique id of the line item that this deduction is for. Is required when `discounts[entity_type]`
                      is `item_level_coupon`
                      or `document_level_coupon`
                      .
                    maxLength: 40
                    example: null
                  entity_type:
                    type: string
                    deprecated: false
                    description: |
                      The type of deduction and the amount to which it is applied.

                      * item_level_discount -
                        The deduction is due to a [discount](/docs/api/discounts)
                        applied to a line item of the invoice. The discount `id`
                        is available as the `entity_id`.
                      * document_level_discount -
                        The deduction is due to a [discount](/docs/api/discounts)
                        applied to the invoice `sub_total`.
                        The discount `id`
                        is available as the `entity_id`.
                      * item_level_coupon -
                        The deduction is due to a coupon applied to line item. The coupon `id`
                        is passed as `entity_id`
                        .
                      * promotional_credits -
                        The deduction is due to a [promotional credit](/docs/api/promotional_credits)
                        applied to the invoice.
                      * prorated_credits -
                        The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`
                        is `null`
                        in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)
                        .
                      * document_level_coupon -
                        The deduction is due to a coupon applied to the invoice `sub_total`.
                        The coupon id is passed as `entity_id`
                        .
                    enum:
                    - item_level_coupon
                    - document_level_coupon
                    - promotional_credits
                    - prorated_credits
                    - item_level_discount
                    - document_level_discount
                    example: null
                  discount_type:
                    type: string
                    deprecated: false
                    description: |
                      The type of discount that is applied to the line item. Relevant only when `discounts[entity_type]`
                      is one of `item_level_discount`
                      , `item_level_coupon`
                      , `document_level_discount`
                      , or `document_level_coupon`

                      * percentage - when percentage is applied as discount
                      * fixed_amount - when amount is applied as discount
                    enum:
                    - fixed_amount
                    - percentage
                    example: null
                  entity_id:
                    type: string
                    deprecated: false
                    description: |
                      When the deduction is due to a `coupon`
                      or a [discount](/docs/api/discounts)
                      , then this is the `id`
                      of the coupon or discount.
                    maxLength: 100
                    example: null
                  coupon_set_code:
                    type: string
                    deprecated: false
                    description: |
                      The [coupon code](/docs/api/coupon_codes/coupon_code-object#code)
                      , if applicable, used to provide the discount. The [coupon.id](/docs/api/coupons/coupon-object#id)
                      is available in `entity_id`
                      .
                    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: |
                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 `round_off_amount`.
                If there is no `round-off amount`
                , it will display `0`
                .
              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 types. [Learn more](/docs/api/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/invoices/invoice-object#line_items_quantity)
                        which is represented by this line item. For `metered`
                        line items, this value is updated from [usages](/docs/api/usages)
                        once when the invoice is generated as `pending`
                        and finally when the invoice is [closed](/docs/api/invoices/close-a-pending-invoice)
                        .
                      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/2.0/plans.html#pricing-models)
                        for this item price.

                        * 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: |
                        The decimal representation of the unit amount of the `line_item`.
                        The value is in major units of the currency. Returned when the `line_item`
                        is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      maxLength: 39
                      example: null
                    quantity_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        The decimal representation of the quantity of this line_item. Returned when the `line_item`
                        is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      maxLength: 33
                      example: null
                    amount_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        The decimal representation of the amount for the `line_item`
                        , in major units of the currency. Typically equals to `unit_amount_in_decimal`
                        x `quantity_in_decimal`.
                        Returned when [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      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
                      description: |
                        Indicates whether the line item is for a metered item. If `true`, the item is metered; otherwise, it is non-metered.
                      example: null
                    is_percentage_pricing:
                      type: boolean
                      deprecated: false
                      description: |
                        Indicates whether the line item is percentage-based.
                      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: 2000
                      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
                        * 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_item_price - Indicates that this line item is based on plan Item Price
                      enum:
                      - adhoc
                      - plan_item_price
                      - addon_item_price
                      - charge_item_price
                      example: null
                    tax_exempt_reason:
                      type: string
                      deprecated: false
                      description: |
                        The reason due to which the line item price/amount is exempted from tax.

                        * export -
                          You are not registered for tax in the customer's region. This is also the reason code when both `billing_address`
                          and `shipping_address`
                          have not been provided for the customer and subscription respectively
                        * tax_not_configured - If tax is not enabled for the site
                        * zero_value_item - 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.
                        * product_exempt - If the Plan or Addon is marked as Tax exempt
                        * reverse_charge - If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only
                        * customer_exempt - If the Customer is marked as Tax exempt
                        * zero_rated - If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item
                        * tax_not_configured_external_provider - If the tax is not configured for the country in 3rd party tax provider.
                        * high_value_physical_goods - 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
                        * region_non_taxable - 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
                      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
                    proration_mode:
                      type: string
                      deprecated: false
                      description: |
                        Proration mode for the line item.
                      enum:
                      - reset
                      - delta
                      - service_period_revision
                      - adjusted_term
                      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: |
                        The price of the tier if the charge model is a `stairtstep`
                        pricing , or the price of each unit in the tier if the charge model is `tiered`
                        /`volume`
                        pricing.
                      minimum: 0
                      example: null
                    starting_unit_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the `line_items.pricing_model`
                        is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      maxLength: 33
                      example: null
                    ending_unit_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the `line_items.pricing_model`
                        is `tiered`
                        , `volume`
                        or stairstep and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      maxLength: 33
                      example: null
                    quantity_used_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        The decimal representation of the quantity purchased from this tier. Returned when the `line_item`
                        is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      maxLength: 33
                      example: null
                    unit_amount_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for `line_item`.
                        The value is in major units of the currency. Returned when the `line_item`
                        is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      maxLength: 40
                      example: null
                    pricing_type:
                      type: string
                      deprecated: false
                      description: |
                        Pricing type for the tier.

                        * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                        * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                        * flat_fee -
                          Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                          pricing model, `pricing_type`
                          will be set to `flat_fee`
                          by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                      enum:
                      - per_unit
                      - flat_fee
                      - package
                      example: null
                    package_size:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      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: |
                        The type of deduction and the amount to which it is applied.

                        * item_level_discount -
                          The deduction is due to a [discount](/docs/api/discounts)
                          applied to a line item of the invoice. The discount `id`
                          is available as the `entity_id`.
                        * item_level_coupon -
                          The deduction is due to a coupon applied to a line item of the invoice. The coupon `id`
                          is available as `entity_id`
                          .
                        * document_level_discount -
                          The deduction is due to a [discount](/docs/api/discounts)
                          applied to the invoice `sub_total`.
                          The discount `id`
                          is available as the `entity_id`.
                        * prorated_credits -
                          The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`
                          is `null`
                          in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)
                          .
                        * promotional_credits -
                          The deduction is due to a [promotional credit](/docs/api/promotional_credits)
                          applied to the invoice. The `entity_id`
                          is `null`
                          in this case.
                        * document_level_coupon -
                          The deduction is due to a coupon applied to the invoice `sub_total`.
                          The coupon `id`
                          is available as `entity_id`
                          .
                      enum:
                      - item_level_coupon
                      - document_level_coupon
                      - promotional_credits
                      - prorated_credits
                      - item_level_discount
                      - document_level_discount
                      example: null
                    coupon_id:
                      type: string
                      deprecated: false
                      maxLength: 50
                      example: null
                    entity_id:
                      type: string
                      deprecated: false
                      description: |
                        When the deduction is due to a `coupon`
                        or a [discount](/docs/api/discounts)
                        , then this is the `id`
                        of the coupon or discount.
                      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: |
                        The unique id of the line item that this deduction is for. Is required when `discounts[entity_type]`
                        is `item_level_coupon`
                        or `document_level_coupon`
                        .
                      maxLength: 40
                      example: null
                    entity_type:
                      type: string
                      deprecated: false
                      description: |
                        The type of deduction and the amount to which it is applied.

                        * document_level_discount -
                          The deduction is due to a [discount](/docs/api/discounts)
                          applied to the invoice `sub_total`.
                          The discount `id`
                          is available as the `entity_id`.
                        * document_level_coupon -
                          The deduction is due to a coupon applied to the invoice `sub_total`.
                          The coupon id is passed as `entity_id`
                          .
                        * item_level_discount -
                          The deduction is due to a [discount](/docs/api/discounts)
                          applied to a line item of the invoice. The discount `id`
                          is available as the `entity_id`.
                        * promotional_credits -
                          The deduction is due to a [promotional credit](/docs/api/promotional_credits)
                          applied to the invoice.
                        * prorated_credits -
                          The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`
                          is `null`
                          in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)
                          .
                        * item_level_coupon -
                          The deduction is due to a coupon applied to line item. The coupon `id`
                          is passed as `entity_id`
                          .
                      enum:
                      - item_level_coupon
                      - document_level_coupon
                      - promotional_credits
                      - prorated_credits
                      - item_level_discount
                      - document_level_discount
                      example: null
                    discount_type:
                      type: string
                      deprecated: false
                      description: |
                        The type of discount that is applied to the line item. Relevant only when `discounts[entity_type]`
                        is one of `item_level_discount`
                        , `item_level_coupon`
                        , `document_level_discount`
                        , or `document_level_coupon`

                        * percentage - when percentage is applied as discount
                        * fixed_amount - when amount is applied as discount
                      enum:
                      - fixed_amount
                      - percentage
                      example: null
                    entity_id:
                      type: string
                      deprecated: false
                      description: |
                        When the deduction is due to a `coupon`
                        or a [discount](/docs/api/discounts)
                        , then this is the `id`
                        of the coupon or discount.
                      maxLength: 100
                      example: null
                    coupon_set_code:
                      type: string
                      deprecated: false
                      description: |
                        The [coupon code](/docs/api/coupon_codes/coupon_code-object#code)
                        , if applicable, used to provide the discount. The [coupon.id](/docs/api/coupons/coupon-object#id)
                        is available in `entity_id`
                        .
                      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: |
                  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 `round_off_amount`.
                  If there is no `round-off amount`
                  , it will display `0`
                  .
                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.

                  * 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
                  * 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:
                - adhoc
                - plan_item_price
                - addon_item_price
                - charge_item_price
                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: |
                  The decimal representation of the amount for the charge, in major units of the currency. Typically equals to `unit_amount_in_decimal`
                  x `quantity_in_decimal`.
                  Returned when [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                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/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/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
              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: |
                        The price of the tier if the charge model is a `stairtstep`
                        pricing , or the price of each unit in the tier if the charge model is `tiered`
                        /`volume`
                        pricing.
                      minimum: 0
                      example: null
                    starting_unit_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        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 `ending_unit_in_decimal`
                        of the next lower tier. Returned only when the `line_items.pricing_model`
                        is `tiered`
                        , `volume`
                        or `stairstep`
                        and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      maxLength: 33
                      example: null
                    ending_unit_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        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 `starting_unit_in_decimal`
                        of the next higher tier. Returned only when the `line_items.pricing_model`
                        is `tiered`
                        , `volume`
                        or stairstep and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      maxLength: 33
                      example: null
                    quantity_used_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        The decimal representation of the quantity purchased from this tier. Returned when the `line_item`
                        is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      maxLength: 33
                      example: null
                    unit_amount_in_decimal:
                      type: string
                      deprecated: false
                      description: |
                        The decimal representation of the per-unit price for the tier when the `pricing_model`
                        is `tiered`
                        or `volume`.
                        When the `pricing_model`
                        is `stairstep`
                        , it is the decimal representation of the total price for `line_item`.
                        The value is in major units of the currency. Returned when the `line_item`
                        is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                        is enabled.
                      maxLength: 40
                      example: null
                    pricing_type:
                      type: string
                      deprecated: false
                      description: |
                        Pricing type for the tier.

                        * flat_fee -
                          Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                          pricing model, `pricing_type`
                          will be set to `flat_fee`
                          by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                        * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                        * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                      enum:
                      - per_unit
                      - flat_fee
                      - package
                      example: null
                    package_size:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        Package size for the tier when pricing type is `package`.
                        Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                      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 unique ID of the
                  [business entity](/docs/api/getting-started)
                  of this subscription. This is always the same as the
                  [business entity](/docs/api/subscriptions/subscription-object#customer_id)
                  of the customer.
                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: |
        ### Introduction

        When important changes occur on your Chargebee site, they are recorded as events. An event contains data about the affected resources and metadata, such as the timestamp of the change. For example, when a subscription is canceled due to non-payment, an event such as `subscription_cancelled` is recorded.

        ### Webhooks

        If webhooks are [configured](https://www.chargebee.com/docs/webhook_settings.html#configure-webhooks) in Chargebee, events trigger those webhooks. If multiple webhooks are configured, Chargebee calls each webhook sequentially for every event. If a webhook call fails or times out, it is retried based on a [fixed schedule](https://www.chargebee.com/docs/webhook_settings.html#automatic-retries). The webhook call is an HTTP POST with the content type `application/json`.

        #### Retries and Duplicate Handling

        To mark a webhook notification successful, the webhook must return an [HTTP status code](http://en.wikipedia.org/wiki/List_of_HTTP_status_codes) in the `2XX` range. If a `2XX` response is not received, Chargebee [retries](https://www.chargebee.com/docs/webhook_settings.html#automatic-retries) the webhook call with increasing delays for up to 2 days. You can also [resend](https://www.chargebee.com/docs/webhook_settings.html#automatic-retries) webhook calls manually from the web console.
        Due to webhook retries, it is possible that your application receives the same webhook more than once. Detect such duplicates within your application to ensure the idempotency of the webhook call. This can be done by examining the [id](/docs/api/events/event-object#id) parameter since its value uniquely identifies an event.
        For example, your application can do the following for each webhook notification:

        1. Get the event `id` and keep it in a persistent store such as a relational database or redis.
        2. Check whether the event `id` is already processed.
        3. If the event has not been processed, process it; otherwise, it is a duplicate event, so it can be ignored.
        4. Also, since the last retry for a webhook happens around 3 days and 7 hours after the original event trigger, keep the idempotency window at 3 days and 7 hours. In other words, you can purge stored event IDs that are older than 3 days and 7 hours.

        #### Out-of-order Delivery

        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 `resource_version` attribute of the resource sent by the webhook. For every change made to the resource, `resource_version` is updated with a new timestamp in milliseconds.
        For example, if you wish to sync resource changes from Chargebee to your application, you can:

        1. Get the value `rv1` of the `resource_version` attribute from the resource in the webhook.
        2. Get the value `rv2` of `resource_version` from the resource stored on your side.
        3. If `rv1` \> `rv2`, process the resource; otherwise, ignore.

        **API Version**
        Chargebee supports multiple API versions now. The [`api_version`](/docs/api/events/event-object#api_version) attribute indicates the API version based on which the event content is structured. While processing webhooks, ensure that `api_version` is the same as the API version used by your webhook server's client library.

        #### Securing Your Webhook URL

        You can have **basic authentication**
        for the webhook URL.

        1. On the Webhook Settings page (**Settings \> Configure Chargebee \> Webhooks** ), select the webhook tab and check the option **My webhook URL is protected by basic authentication.**
        2. Enter **Username** and **Password** and click **Update Webhook.** **OR** Generate a random key and have it as part of your webhook URL *eg, http://yourapp.com/chargebee-webhook/cuktqaem0i2fkd5jt9cdtojcn9cvb3Y*

        In addition to securing your webhook, you can ensure the integrity of the event data by fetching it again using the [Retrieve an Event](/docs/api/events/retrieve-an-event)
        API call.

        #### About Webhook IP Addresses

        Webhooks from Chargebee originate from a [specific set of IP addresses](/docs/api/webhooks).
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Unique identifier of an 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: |
            Indicates the origin of the operation that triggered the event.

            * admin_console -
              The event was triggered by an operation performed through the [Chargebee Billing dashboard](https://app.chargebee.com)
              .
            * external_service - The event was triggered by an operation associated with a webhook.
            * scheduled_job - The event was triggered by a scheduled job in Chargebee Billing.
            * bulk_operation -
              The event was triggered by a [bulk operation](https://www.chargebee.com/docs/billing/2.0/data-operations/bulk-operations)
              initiated by you in Chargebee Billing.
            * hosted_page -
              The event was triggered by an operation performed by the customer through one of the [Chargebee Hosted Pages](/docs/api/hosted_pages)
              .
            * portal -
              The event was triggered by an operation performed by a customer through the [Self-Serve Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html)
              .
            * system - The event was triggered automatically by Chargebee Billing.
            * migration -
              The event was 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)
              (such as test, live, or sandbox).
            * none - No source can be identified for the event.
            * api -
              The event was triggered by an operation performed through the [public API](/docs/api/getting-started)
              .
            * js_api -
              The event was triggered by an operation performed through [Chargebee.js](https://www.chargebee.com/checkout-portal-docs/)
              .
          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: |
            The "user" that triggered the event. The value depends on the `source`

            * When `source` is `admin_console`: the email address of the user that triggered the event.
            * When `source` is `api`, `js_api` or `bulk_operation`: the [name](https://www.chargebee.com/docs/api_keys.html#create-an-api-key) of the API key that was used to trigger the event.
            * When the `source` is `external_service`: the name of the service that called our webhook. Eg. `ADYEN`, `STRIPE`, `AMAZON_PAYMENTS` etc.
            * When the `source` is `hosted_page` or `portal`: the `user` attribute is not passed.
          maxLength: 150
          example: null
        event_type:
          type: string
          deprecated: false
          description: |
            The type of event provided by Chargebee. See [event types](/docs/api/events/event-types)
            for a complete list.

            * card_deleted - Sent when a card is deleted for a customer
            * rule_created - Triggered when a rule is created.
            * 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'.
            * omnichannel_subscription_item_updated - Triggered when an omnichannel subscription item is updated.
            * customer_changed - Sent when a customer is changed
            * invoice_deleted - Event triggered when an invoice is deleted.
            * omnichannel_subscription_item_changed - Triggered when an omnichannel subscription item is changed
            * subscription_shipping_address_updated - Triggered when shipping address is added or updated for a subscription.
            * differential_price_created - Triggered when a differential price is created
            * subscription_created - Sent when a new subscription is created.
            * payment_initiated - Sent when a payment is initiated via direct debit
            * quote_updated - Triggered when quote is updated
            * payment_source_added - Sent when a payment source is added for a customer.
            * contract_term_created - Triggered when new contract term is created
            * subscription_business_entity_changed - Sent when a subscription's business entity is changed.
            * subscription_deleted - Sent when a subscription has been deleted
            * differential_price_deleted - Triggered when a differential price is deleted
            * omnichannel_subscription_created - Triggered when an omnichannel subscription is created
            * voucher_created - Triggered when a payment voucher is created.
            * subscription_ramp_drafted - Triggered when a subscription ramp is moved to draft status.
            * rule_deleted - Triggered when a rule is deleted.
            * transaction_deleted - Triggered when a transaction is deleted.
            * item_family_deleted - Triggered when an item family is deleted
            * payment_failed - Sent when attempt to charge customer's credit card fails
            * subscription_reactivated_with_backdating - Sent when the subscription is moved from cancelled state to active or in_trial state with past date
            * omnichannel_subscription_item_cancellation_scheduled - Triggered when an omnichannel subscription item is scheduled for cancellation
            * omnichannel_subscription_item_resumed - Triggered when an omnichannel subscription item is resumed
            * payment_source_expiring - Sent when the customer's payment source is expiring soon. Sent 30 days before the expiry date.
            * payment_schedules_created - Event triggered when new payment schedules are created for an invoice
            * subscription_entitlements_updated - Triggered when subscription entitlements are updated for a subscription change.
            * price_variant_updated - Triggered when a price variant is updated.
            * omnichannel_subscription_item_dunning_expired - Triggered when an omnichannel subscription item's dunning has expired
            * item_price_updated - Triggered when an item price is updated
            * order_ready_to_process - Triggered when order reaches its order date
            * entitlement_overrides_updated - Triggered when an override entitlement is updated
            * item_updated - Triggered when an item is updated
            * coupon_set_updated - Sent when a coupon set is changed
            * subscription_reactivated - Sent when the subscription is moved from cancelled state to active or in_trial state
            * subscription_scheduled_changes_removed - Sent when scheduled change for the subscription is removed.
            * customer_business_entity_changed - Sent when a customer's business entity is changed.
            * payment_refunded - Sent when a payment refund is made
            * omnichannel_subscription_item_mrr_updated - Triggered when an omnichannel subscription item's MRR is updated.
            * subscription_started - Sent when a 'future' subscription gets started at the scheduled date.
            * attached_item_created - Triggered when an Attached item is created
            * token_created - Sent when a Token is created
            * item_family_created - Triggered when an item family is created
            * subscription_created_with_backdating - Sent when a new subscription is created with backdating.
            * unbilled_charges_deleted - Triggered when unbilled charges are deleted.
            * omnichannel_subscription_item_renewed - Triggered when an omnichannel subscription item is renewed
            * subscription_ramp_applied - Triggered when a subscription ramp is applied.
            * promotional_credits_added - Sent when promotional credits are added to a customer.
            * 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'.
            * item_entitlements_updated - Triggered when item entitlements are updated to a feature
            * card_expired - Sent when a card for a customer is expired
            * payment_intent_created - Sent when a Payment intent is created
            * subscription_changed_with_backdating - Sent after the subscription's recurring items have been changed with backdated date
            * subscription_scheduled_cancellation_removed - Sent when scheduled cancellation is removed for the subscription.
            * omnichannel_subscription_item_resubscribed - Triggered when an omnichannel subscription item is resubscribed
            * feature_updated - Triggered when an feature is updated
            * payment_schedule_scheme_created - Event triggered when a new payment schedule scheme is created
            * omnichannel_subscription_imported - Triggered when an omnichannel subscription item is imported
            * vault_token_created - Triggered when a payment method is tokenized and stored in the vault.
            * tax_withheld_refunded - Sent when a tax withheld refund is made
            * unbilled_charges_voided - Triggered when unbilled charges are voided.
            * customer_moved_out - Sent when a customer is copied to another site
            * dunning_updated - Sent when dunning is paused for an invoice.
            * feature_created - Triggered when a feature is created.
            * record_purchase_failed - Triggered when an omnichannel record purchase is failed
            * coupon_codes_deleted - Sent when coupon codes are deleted in coupon set
            * subscription_paused - Sent when the subscription is paused.
            * order_updated - Triggered when order is updated
            * subscription_movement_failed - Triggered when a subscription movement failed
            * unbilled_charges_created - Triggered when unbilled charges are created.
            * subscription_moved_in - Triggered when a subscription moved from other customer
            * feature_archived - Triggered when a feature is archived.
            * subscription_ramp_deleted - Triggered when a subscription ramp is deleted.
            * payment_succeeded - Sent when the payment is successfully collected
            * voucher_expired - Triggered when a payment voucher is expired.
            * mrr_updated - Sent when either of MRR or CMRR of a subscription changes
            * subscription_scheduled_resumption_removed - Triggered when scheduled resumption 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.
            * order_ready_to_ship - Triggered when order reaches its shipping date
            * einvoice_created - Triggered when an e-invoice is created for an invoice or credit note.
            * omnichannel_subscription_item_cancelled - Triggered when an omnichannel subscription item is cancelled
            * payment_due_reminder - Sent after scheduled days of payment failure
            * purchase_created - Triggered when purchase action completed successfully
            * subscription_trial_end_reminder - Sent when the customer's trial period is about to end.
            * feature_activated - Triggered when a feature `status` transitions to `active` for the first time.
            * subscription_renewed - Sent when the subscription is renewed from the current term.
            * vault_token_deleted - Triggered when a vaulted payment method is deleted from the vault.
            * item_created - Triggered when an item is created
            * coupon_codes_updated - Sent when coupon codes are updated
            * gift_unclaimed - Triggered when a new gift is unclaimed and is ready to be claimed
            * subscription_entitlements_created - Triggered when subscription entitlements are created for a new subscription
            * subscription_ramp_updated - Triggered when a subscription ramp is updated.
            * virtual_bank_account_added - Sent when a virtual bank account is added for a customer.
            * subscription_moved_out - Triggered when a subscription moved to other customer
            * contract_term_completed - Triggered when contract term is completed
            * feature_deleted - Triggered when a feature is deleted
            * subscription_renewal_reminder - Sent before each subscription's renewal based on plan's period
            * coupon_updated - Sent when a coupon is changed.
            * token_consumed - Sent when a Token is consumed
            * omnichannel_subscription_item_upgraded - Triggered when an omnichannel subscription item is upgraded
            * transaction_created - Triggered when a transaction is recorded
            * payment_schedule_scheme_deleted - Event triggered when a payment schedule scheme is deleted
            * customer_deleted - Sent when a customer is deleted
            * subscription_items_renewed - Sent when one or more Subscription Items are renewed
            * coupon_deleted - Sent when a coupon is deleted.
            * quote_deleted - Triggered when quote is deleted
            * card_updated - Sent when the card is updated for a customer.
            * coupon_created - Sent when a coupon is created.
            * quote_created - Triggered when quote is created
            * add_usages_reminder - Sent every month day before renewal date of plan's period
            * business_entity_updated - Sent when a business entity is updated.
            * subscription_changed - Sent after the subscription's recurring items have been changed
            * customer_created - Sent when a new customer is created, either directly or automatically during subscription creation.
            * price_variant_created - Triggered when a price variant is created.
            * coupon_set_deleted - Sent when a coupon set is deleted
            * refund_initiated - Sent when a refund is initiated via direct debit
            * order_cancelled - Triggered when order is cancelled
            * entitlement_overrides_removed - Triggered when an override entitlement is removed
            * coupon_codes_added - Sent when coupon codes are added in coupon set
            * omnichannel_subscription_item_paused - Triggered when an omnichannel subscription item is paused
            * card_added - Sent when a card is added for a customer.
            * gift_cancelled - Triggered when a gift is cancelled.
            * entitlement_overrides_auto_removed - Triggered when Subscription entitlements overrides for a feature are auto removed after expiry
            * omnichannel_subscription_moved_in - Triggered when an omnichannel subscription is moved to another customer
            * omnichannel_subscription_item_downgraded - Triggered when an omnichannel subscription item is downgraded
            * ledger_updated - Triggered when a batch of [ledger_operations](/docs/api/ledger_operations) is persisted for a subscription unit. The event content includes the related `ledger_operations`, `ledger_account_balance`, `grant_blocks`, and `ledger_entries`.
            * payment_source_deleted - Sent when a payment source is deleted for a customer
            * omnichannel_transaction_created - Triggered when an omnichannel transaction is created.
            * grant_blocks_created - Triggered when one or more [grant_blocks](/docs/api/grant_blocks) are created for a subscription unit.
            * credit_note_created - Sent when a credit note is created
            * subscription_resumption_scheduled - Triggered when the subscription resumption is scheduled.
            * item_price_deleted - Triggered when an item price is deleted
            * subscription_advance_invoice_schedule_updated - Triggered when scheduled advance invoice is updated for a subscription.
            * item_deleted - Triggered when an item is deleted
            * omnichannel_one_time_order_item_cancelled - Triggered when an omnichannel one time order item is cancelled
            * gift_claimed - Triggered when a gift is claimed
            * feature_reactivated - Triggered when a feature `status` transitions to `active` for the second time or more.
            * vault_token_updated - Triggered when a vaulted payment method is updated.
            * subscription_activated - Sent after the subscription has been moved from trial to active state
            * subscription_resumed - Sent when the subscription is moved from paused state to active state
            * sales_order_updated - Triggered when a sales order is updated.
            * credit_note_deleted - Sent when a credit note is deleted
            * item_price_entitlements_removed - Triggered when item price entitlements are removed for a feature
            * subscription_advance_invoice_schedule_added - Triggered when advance invoice is scheduled for a subscription.
            * differential_price_updated - Triggered when a differential price is updated
            * alert_status_changed -
              Triggered when an alert's runtime status for a subscription changes between IN_ALARM and WITHIN_LIMIT.
              This indicates a change in the subscription's usage relative to the alert threshold and applies only to usage-based billing.
            * order_deleted - Triggered when order is deleted
            * omnichannel_subscription_item_scheduled_cancellation_removed - Triggered when an omnichannel subscription item scheduled cancellation is removed
            * token_expired - Sent when a Token is expired
            * price_variant_deleted - Triggered when a price variant is deleted.
            * 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.
            * subscription_cancellation_reminder - Sent when the customer's subscription is nearing its scheduled cancellation date.
            * rule_updated - Triggered when a rule is updated.
            * omnichannel_subscription_item_reactivated - Triggered when an omnichannel subscription item's refund is reversed
            * 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.
            * order_delivered - Triggered when order is marked as delivered
            * 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.
            * subscription_ramp_created - Triggered when a subscription ramp is created.
            * omnichannel_subscription_item_expired - Triggered when an omnichannel subscription item is expired
            * authorization_succeeded - Triggered when an authorization transaction is created.
            * invoice_generated_with_backdating - Event triggered when a new invoice is generated with past date as invoice date.
            * omnichannel_subscription_item_change_scheduled - Triggered when an omnichannel subscription item change is scheduled
            * subscription_cancellation_scheduled - Sent when subscription is scheduled to cancel at end of current term
            * order_created - Triggered when order is created
            * hierarchy_deleted - Triggered when a hierarchy is deleted
            * subscription_activated_with_backdating - Sent after the subscription changes to `active` from another `status`, while the change is backdated.
            * tax_withheld_recorded - Triggered when a tax withheld is recorded for an invoice
            * einvoice_updated - Triggered when an e-invoice is updated (for example when its status or provider responses change).
            * credit_note_created_with_backdating - Sent when a credit note is created with past date as credit note date
            * omnichannel_subscription_item_pause_scheduled - Triggered when an omnichannel subscription item scheduled for pause
            * gift_updated - Triggered when a gift is updated
            * order_resent - Triggered when order is resent
            * hierarchy_created - Triggered when a hierarchy is created
            * voucher_create_failed - Triggered when a payment voucher creation fails.
            * customer_moved_in - Sent when a customer is copied from another site
            * customer_entitlements_updated - Triggered when entitlements for the list of customers got updated.
            * item_price_entitlements_updated - Triggered when item Price entitlements are updated to a feature
            * omnichannel_subscription_item_grace_period_expired - Triggered when an omnichannel subscription item's grace period has expired
            * attached_item_deleted - Triggered when an Attached item is deleted
            * unbilled_charges_invoiced - Triggered when unbilled charges are invoiced.
            * subscription_pause_scheduled - Sent when the subscription is scheduled to pause.
            * order_returned - Triggered when order is marked as returned
            * payment_source_expired - Sent when a payment source for a customer is expired
            * contract_term_terminated - Triggered when contract term is terminated
            * payment_source_updated - Sent when the payment source is updated for a customer or when role is assigned to the payment source.
            * pending_invoice_updated - Triggered when you make the following changes to a pending invoice: add a charge, add a non-recurring addon, or delete a line item.
            * omnichannel_subscription_item_grace_period_started - Triggered when an omnichannel subscription item's grace period has started
            * subscription_advance_invoice_schedule_removed - Triggered when scheduled advance invoice is removed for a subscription.
            * tax_withheld_deleted - Triggered when a tax withheld is deleted
            * omnichannel_subscription_item_dunning_started - Triggered when an omnichannel subscription item's dunning has started
            * business_entity_created - Sent when a business entity is created.
            * sales_order_created - Triggered when a sales order is created.
            * item_price_created - Triggered when an item price is created
            * virtual_bank_account_updated - Sent when the virtual bank account is updated for a customer.
            * credit_note_updated - Sent when a credit note is updated
            * subscription_scheduled_pause_removed - Triggered when scheduled pause is removed for the subscription.
            * card_expiry_reminder - Sent 30 days before the customer's credit card expires.
            * coupon_set_created - Sent when a coupon set is created
            * virtual_bank_account_deleted - Sent when a virtual bank account is deleted for a customer.
            * omnichannel_one_time_order_created - Triggered when an omnichannel one time order is created
            * gift_scheduled - Triggered when a new gift is created
            * payment_schedules_updated - Event triggered when payment schedules are updated for an invoice
            * business_entity_deleted - Sent when a business entity is deleted.
            * omnichannel_subscription_item_recovered - Triggered when an omnichannel subscription item recovers from a billing issue and is active again.
            * promotional_credits_deducted - Sent when a customer prmotion credits deducted
            * ledger_account_balance_updated - Triggered when a [ledger_account_balance](/docs/api/ledger_account_balances) changes for a subscription unit.
            * contract_term_renewed - Triggered when new contract term is renewed
            * usage_file_ingested -
              Triggered when a [usage_file](/docs/api/usage_files)
              is successfully ingested.
            * subscription_trial_extended - Sent when a subscription trial is extended.
            * item_entitlements_removed - Triggered when item entitlements are removed for a feature
            * gift_expired - Triggered when a gift expires
            * omnichannel_subscription_item_scheduled_change_removed - Triggered when an omnichannel subscription item scheduled change is removed
            * contract_term_cancelled - Triggered when contract term is cancelled
            * authorization_voided - Triggered when an 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.
            * item_family_updated - Triggered when an item family is updated
            * attached_item_updated - Triggered when an Attached item is updated
            * invoice_updated - Triggered when changes are made to a finalized invoice, including voiding, deletion, invoice address updates, status changes, and payment changes such as applying or removing a payment, applying or removing a credit, and credit note creation. `pending_invoice_updated` is triggered for changes specific to pending invoices; invoice_updated covers all other invoice changes.
            * grant_blocks_updated - Triggered when one or more [grant_blocks](/docs/api/grant_blocks) are updated for a subscription unit.
            * payment_intent_updated - Sent when a Payment intent is updated
            * payment_source_locally_deleted - Sent when a payment source for a customer removed from Chargebee
          enum:
          - 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
          - einvoice_created
          - einvoice_updated
          - payment_schedules_created
          - payment_schedules_updated
          - payment_schedule_scheme_created
          - payment_schedule_scheme_deleted
          - subscription_renewal_reminder
          - add_usages_reminder
          - payment_due_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
          - item_family_created
          - item_family_updated
          - item_family_deleted
          - item_created
          - item_updated
          - item_deleted
          - item_price_created
          - item_price_updated
          - item_price_deleted
          - attached_item_created
          - attached_item_updated
          - attached_item_deleted
          - differential_price_created
          - differential_price_updated
          - differential_price_deleted
          - feature_created
          - feature_updated
          - feature_deleted
          - feature_activated
          - feature_reactivated
          - feature_archived
          - item_entitlements_updated
          - entitlement_overrides_updated
          - entitlement_overrides_removed
          - item_entitlements_removed
          - entitlement_overrides_auto_removed
          - subscription_entitlements_created
          - subscription_entitlements_updated
          - business_entity_created
          - business_entity_updated
          - business_entity_deleted
          - customer_business_entity_changed
          - subscription_business_entity_changed
          - payment_source_business_entity_changed
          - purchase_created
          - voucher_created
          - voucher_expired
          - voucher_create_failed
          - item_price_entitlements_updated
          - item_price_entitlements_removed
          - subscription_ramp_created
          - subscription_ramp_deleted
          - subscription_ramp_applied
          - subscription_ramp_drafted
          - subscription_ramp_updated
          - price_variant_created
          - price_variant_updated
          - price_variant_deleted
          - customer_entitlements_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
          - omnichannel_subscription_moved_in
          - omnichannel_transaction_created
          - alert_status_changed
          - omnichannel_subscription_item_updated
          - omnichannel_subscription_item_recovered
          - omnichannel_subscription_item_mrr_updated
          - ledger_account_balance_updated
          - grant_blocks_created
          - grant_blocks_updated
          - ledger_updated
          - business_rule_created
          - business_rule_updated
          - business_rule_activated
          - business_rule_deactivated
          - business_rule_deleted
          - business_rule_released
          - vault_token_created
          - vault_token_updated
          - vault_token_deleted
          - business_rules_applied
          - business_ruleset_created
          - business_ruleset_updated
          - business_ruleset_activated
          - business_ruleset_deactivated
          - business_ruleset_deleted
          example: null
        site_id:
          type: string
          deprecated: false
          description: |
            Unique identifier of the Chargebee [site](https://www.chargebee.com/docs/billing/2.0/getting-started/sites-intro) where this event was created. This value does not change if the site is renamed.
          maxLength: 60
          example: null
        api_version:
          type: string
          default: v1
          deprecated: false
          description: |
            The Chargebee API version used to render this event content. When processing webhooks, ensure that this version matches the one 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/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: "The email address of the user, if captured, in the API operation\
            \ that triggered the event. This email address is captured through either\
            \ the `chargebee-request-origin-user` or `chargebee-request-origin-user-encoded`\
            \ [custom HTTP request headers](/docs/api/advanced-features).  \n**Note**\
            \ :\nApplicable only when `event_source` is `api`.\n"
          example: null
        webhooks:
          type: array
          deprecated: false
          description: |
            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 `webhook`
            object data is a queued operation and hence there can be an additional delay of up to 5 seconds.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  Unique identifier of a webhook.
                maxLength: 40
                example: null
              webhook_status:
                type: string
                deprecated: false
                description: |
                  * **When the event resource is retrieved via API:** Represents the status of the webhook call made to this webhook.
                  * **When the event resource is passed as part of a webhook call:** The `webhooks` object is unavailable on the first webhook call for the event. For subsequent calls, this attribute holds the status from after the last retry.

                  * disabled - Disabled as no longer used
                  * failed - Webhook call has been suspended after the all retries have resulted in failure.
                  * succeeded - Webhook call was successful.
                  * rate_limited - Webhook call was rate limited.
                  * scheduled - Webhook call has been scheduled.
                  * re_scheduled - Webhook call has been rescheduled due failure(s) in previous call(s)
                  * not_applicable - Webhook call is not applicable for this event.
                  * skipped - Skipped as specified in request
                  * not_configured - Webhook was not configured when this event occurred
                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:
      - 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
      - einvoice_created
      - einvoice_updated
      - payment_schedules_created
      - payment_schedules_updated
      - payment_schedule_scheme_created
      - payment_schedule_scheme_deleted
      - subscription_renewal_reminder
      - add_usages_reminder
      - payment_due_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
      - item_family_created
      - item_family_updated
      - item_family_deleted
      - item_created
      - item_updated
      - item_deleted
      - item_price_created
      - item_price_updated
      - item_price_deleted
      - attached_item_created
      - attached_item_updated
      - attached_item_deleted
      - differential_price_created
      - differential_price_updated
      - differential_price_deleted
      - feature_created
      - feature_updated
      - feature_deleted
      - feature_activated
      - feature_reactivated
      - feature_archived
      - item_entitlements_updated
      - entitlement_overrides_updated
      - entitlement_overrides_removed
      - item_entitlements_removed
      - entitlement_overrides_auto_removed
      - subscription_entitlements_created
      - subscription_entitlements_updated
      - business_entity_created
      - business_entity_updated
      - business_entity_deleted
      - customer_business_entity_changed
      - subscription_business_entity_changed
      - payment_source_business_entity_changed
      - purchase_created
      - voucher_created
      - voucher_expired
      - voucher_create_failed
      - item_price_entitlements_updated
      - item_price_entitlements_removed
      - subscription_ramp_created
      - subscription_ramp_deleted
      - subscription_ramp_applied
      - subscription_ramp_drafted
      - subscription_ramp_updated
      - price_variant_created
      - price_variant_updated
      - price_variant_deleted
      - customer_entitlements_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
      - omnichannel_subscription_moved_in
      - omnichannel_transaction_created
      - alert_status_changed
      - omnichannel_subscription_item_updated
      - omnichannel_subscription_item_recovered
      - omnichannel_subscription_item_mrr_updated
      - ledger_account_balance_updated
      - grant_blocks_created
      - grant_blocks_updated
      - ledger_updated
      - business_rule_created
      - business_rule_updated
      - business_rule_activated
      - business_rule_deactivated
      - business_rule_deleted
      - business_rule_released
      - vault_token_created
      - vault_token_updated
      - vault_token_deleted
      - business_rules_applied
      - business_ruleset_created
      - business_ruleset_updated
      - business_ruleset_activated
      - business_ruleset_deactivated
      - business_ruleset_deleted
      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.

        **Note:** Export operations are eventually consistent, so exported data might not reflect a recent write. For more information, see [Read consistency](/docs/api/read-consistency).
      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: |
                The time until which the `download_url`
                is valid.
              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
    FamAutoCalcRequest:
      type: object
      properties:
        status:
          type: string
          deprecated: false
          maxLength: 500
          example: null
        request_type:
          type: string
          deprecated: false
          maxLength: 500
          example: null
        version:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        fault_trace:
          type: string
          deprecated: false
          maxLength: 65000
          example: null
        retry_count:
          type: integer
          format: int32
          deprecated: false
          example: null
      example: null
    FamManualCalcRequest:
      type: object
      properties:
        feature_id:
          type: string
          deprecated: false
          maxLength: 500
          example: null
        status:
          type: string
          deprecated: false
          maxLength: 500
          example: null
        request_type:
          type: string
          deprecated: false
          maxLength: 500
          example: null
        version:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        fault_trace:
          type: string
          deprecated: false
          maxLength: 65000
          example: null
        retry_count:
          type: integer
          format: int32
          deprecated: false
          example: null
      example: null
    Feature:
      type: object
      additionalProperties: true
      description: "Subscriptions are created in Chargebee using items. Items represent\
        \ the products or services that you offer to your customers. Items often differ\
        \ in the number of product features that are available to them. The Features\
        \ API helps you define the various features offered as part of your product\
        \ line. It also defines the entitlements that items and subscriptions can\
        \ have towards said features.  \n**Note**\n\nThe maximum number of features\
        \ a site can have is 400.\n\nFeatures of this API\n--------------------\n\n\
        The Features API enables you to:\n\n* Define the set of features provided\
        \ by your product.\n* Specify the entitlements that items have towards said\
        \ features.\n* For a given subscription, modify the entitlements inherited\
        \ from items in the subscription.\n* Offer additional feature entitlements\
        \ to subscriptions than those inherited from items in the subscription.\n\
        * Serve as a source of truth to your provisioning systems for subscription\
        \ entitlements.\n* Use entitlement information to understand which features\
        \ drive value and revenue.\n\n**See also**\n\n* [Entitlements](/docs/api/entitlements)\n\
        * [Subscription Entitlements](/docs/api/subscription_entitlements)\n* [Entitlement\
        \ Overrides](/docs/api/entitlement_overrides)\n"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            A unique and immutable identifier for the feature. You can set it yourself, in which case it is recommended that a human-readable format (or slug) be used. For example, `number-of-users-ccjht01`.
            When not provided, a random value is automatically set.
          maxLength: 50
          example: null
        name:
          type: string
          deprecated: false
          description: |
            A case-sensitive unique name for the feature. For example: `user license`
            , `data storage`
            , `Salesforce Integration`
            , `devices`
            , `UHD Streaming`
            , and so on.

            **Note:**
            This name is not displayed on any customer-facing documents or pages such as [invoice PDFs](/docs/api/invoices/retrieve-invoice-as-pdf)
            or [hosted pages](/docs/api/hosted_pages).
            However, in the future, it is likely to be introduced on the [Self-Serve Portal](/docs/api/portal_sessions)
            .
          maxLength: 50
          example: null
        description:
          type: string
          deprecated: false
          description: |
            A brief description of the feature. For example: `Access to 10TB cloud storage`
            .
          maxLength: 500
          example: null
        status:
          type: string
          deprecated: false
          description: |
            The current status of the feature.

            * active -
              A `draft`
              or an `archived`
              feature can be changed to `active`.
              Any [entitlements](/docs/api/entitlements)
              or [subscription entitlements](/docs/api/subscription_entitlements)
              defined for the feature take effect immediately.
            * draft -
              The feature is in an unpublished state. [Entitlements](/docs/api/entitlements)
              and [subscription entitlements](/docs/api/subscription_entitlements)
              can be created for a draft feature but they are not effective until the feature is active. A feature `status`
              cannot be changed back to `draft`
              once it is in `active`
              or `archived`
              `status`
              .
            * archived -
              An `active`
              feature can be changed to `archived`.
              Once `archived`
              , no **new**
              [entitlements](/docs/api/entitlements)
              or [subscription entitlements](/docs/api/subscription_entitlements)
              can be created for the feature. However, any pre-existing item or subscription entitlements from the time that the feature was `active`
              , remain effective.
          enum:
          - active
          - archived
          - draft
          example: null
        type:
          type: string
          deprecated: false
          description: |
            The type of feature.

            * quantity -
              The feature is quantity-based and entitlement levels available for it are a set of predefined number of quantity units. For example, a feature with `name`
              such as `number of users`
              can have entitlement levels of say, `5`
              , `20`
              , `50`
              , and `100`.
              `levels[is_unlimited]`
              is used for specifying the "unlimited" entitlement level.
            * range -
              The feature is quantity-based and the entitlement levels available for it are the set of whole numbers within a range. The range is defined by a minimum and a maximum value. For example, a feature such as `number of users`
              can have entitlement levels starting at `5`
              users and go up to `50000`.
              `levels[is_unlimited]`
              is used for specifying the "unlimited" entitlement level.
            * switch - A switch or toggle is a feature that an item or subscription can be either fully entitled to or not entitled to at all.
            * custom -
              The entitlement levels available for this feature are defined as a set of custom values. For example, a feature `Email Support`
              can have entitlement levels as `24×7`
              and `24×5`
              .
          enum:
          - switch
          - custom
          - quantity
          - range
          example: null
        unit:
          type: string
          deprecated: false
          description: |
            For features of `type`
            `quantity`
            or `range`
            , this specifies the unit of measure. The value is expected in the singular form and when used by the system, it is pluralized automatically as needed. For example, for a feature such as `user licenses`
            , the `unit`
            can be `license`
            .
          maxLength: 50
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            The version number of this resource. For every change made to the resource, `resource_version`
            is updated with a new timestamp in milliseconds.
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The version number of this resource. For every change made to the resource, `resource_version`
            is updated with a new timestamp in milliseconds.
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            When the feature was created.
          example: null
        metered:
          type: boolean
          deprecated: false
          description: |
            Indicates if the feature is a metered feature
          example: null
        levels:
          type: array
          deprecated: false
          description: |
            An ordered list of entitlement levels available for the feature. This is only applicable when `type`
            is other than `switch`
            .
            **Note:**
            When the `type`
            of the feature is `switch`
            , this is not applicable. This is because any given entity can be either fully entitled to a `switch`
            feature or not entitled at all; there are no intermediate entitlement levels.
          items:
            type: object
            deprecated: false
            properties:
              name:
                type: string
                deprecated: false
                description: |
                  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 `Email Support`
                  can have entitlement levels named as `All weekdays`
                  , `All days`
                  , `40 hours per week`
                  and so on.

                  When not provided for `feature.type`
                  `quantity`
                  or `range`
                  , this name is auto-generated as the space-separated concatenation of `levels[].value`
                  and the pluralized version of `unit`.
                  For example, if `levels[].value`
                  is `20`
                  and `unit`
                  is `user`
                  , then `levels[].name`
                  becomes `20 users`
                  .
                maxLength: 100
                example: null
              value:
                type: string
                deprecated: false
                description: |
                  The value denoting the entitlement level granted.

                  * **When `type` is `quantity`:** this attribute denotes the quantity of units of the feature for this entitlement level. For example, a feature such as `number of users` can have `levels[].value` as `5`, `20`, `50`, and `100`. `levels[].is_unlimited` is used to set the entitlement level to "unlimited".
                  * **When `type` is `range`:** there can be be only two elements in the `levels[]` array; one corresponding to the minimum value (`levels[0]`) and the other to the maximum value (`levels[1]`) of the range of possible entitlement levels. For example, a feature such as `number of users` may have `levels[0].value` = `5` and `levels[1].value` = `50000`. When the upper limit is "unlimited", then `levels[1].value` is not set and `levels[1].is_unlimited` is `true`.
                  * **When `type` is `custom`:** this attribute denotes the value of this custom entitlement level. For example, a feature `Email Support` can have `levels[].value` as one of say, `24×7` and `24×5`.
                maxLength: 50
                example: null
              level:
                type: integer
                format: int32
                deprecated: false
                description: |
                  This attribute represents the order of the entitlement levels from lowest to highest.

                  * When `type` is `quantity` or `custom`: The lowest entitlement level has the value `0`, the next higher level has the value `1`, followed by `2`, and so on.
                  * When `type` is `range`: This attribute is `0` for the minimum value and `1` for the maximum value in the range.

                  When not defined, it is assumed as the index of the `levels[]`
                  array.
                example: null
              is_unlimited:
                type: boolean
                deprecated: false
                description: |
                  When `type`
                  is `quantity`
                  or `range`
                  , this attribute indicates whether the entitlement level corresponds to unlimited units of the feature. Possible values:

                  * `true`: The entitlement level corresponds to unlimited units of the feature. `levels[].value` is ignored for this level. This can only be set for the level that has the highest value for `levels[].level.`
                  * `false`: The entitlement level does not correspond to unlimited units of the feature.
                example: null
            required:
            - is_unlimited
            - level
            - value
            example: null
          example: null
      required:
      - created_at
      - id
      - metered
      - name
      example: null
    FeatureActivatedEvent:
      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:
            feature:
              $ref: "#/components/schemas/Feature"
            metadata:
              $ref: "#/components/schemas/Metadata"
            impacted_item:
              $ref: "#/components/schemas/ImpactedItem"
            impacted_subscription:
              $ref: "#/components/schemas/ImpactedSubscription"
          required:
          - feature
          - impacted_item
          - impacted_subscription
          - metadata
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    FeatureArchivedEvent:
      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:
            feature:
              $ref: "#/components/schemas/Feature"
            metadata:
              $ref: "#/components/schemas/Metadata"
          required:
          - feature
          - metadata
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      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
    FeatureCreatedEvent:
      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:
            feature:
              $ref: "#/components/schemas/Feature"
            metadata:
              $ref: "#/components/schemas/Metadata"
            impacted_item:
              $ref: "#/components/schemas/ImpactedItem"
            impacted_subscription:
              $ref: "#/components/schemas/ImpactedSubscription"
          required:
          - feature
          - impacted_item
          - impacted_subscription
          - metadata
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    FeatureDeletedEvent:
      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:
            feature:
              $ref: "#/components/schemas/Feature"
            metadata:
              $ref: "#/components/schemas/Metadata"
            impacted_item:
              $ref: "#/components/schemas/ImpactedItem"
            impacted_subscription:
              $ref: "#/components/schemas/ImpactedSubscription"
          required:
          - feature
          - impacted_item
          - impacted_subscription
          - metadata
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    FeatureReactivatedEvent:
      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:
            feature:
              $ref: "#/components/schemas/Feature"
            metadata:
              $ref: "#/components/schemas/Metadata"
          required:
          - feature
          - metadata
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    FeatureUpdatedEvent:
      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:
            feature:
              $ref: "#/components/schemas/Feature"
            metadata:
              $ref: "#/components/schemas/Metadata"
          required:
          - feature
          - metadata
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    FilterCondition:
      type: object
      description: |
        One row of the `filter_conditions` composite on a [global alert](/docs/api/alerts). It limits which subscriptions the alert applies to. When creating an alert, pass parallel arrays `filter_conditions[field][]`, `filter_conditions[operator][]`, and `filter_conditions[value][]`; values at the same index define one condition.
      properties:
        field:
          type: string
          deprecated: false
          description: |
            Subscription attribute to filter on. The API allows only `plan_price_id` (request parameter `filter_conditions[field][]`).

            * plan_price_id - Compares against the subscription's plan price identifier.
          enum:
          - plan_price_id
          example: null
        operator:
          type: string
          deprecated: false
          description: |
            How `field` is compared to `value` (`filter_conditions[operator][]`).

            * equals - The plan price attribute must equal this condition's `value`.
            * not_equals - The plan price attribute must not equal this condition's `value`.
          enum:
          - equals
          - not_equals
          example: null
        value:
          type: string
          deprecated: false
          description: |
            Operand for the operator, typically a plan price identifier. String, up to 50 characters (`filter_conditions[value][]`).
          maxLength: 50
          example: null
      required:
      - field
      - operator
      - value
      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: |
                The time until which the `download_url`
                is valid.
              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
      - payu
      - 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: |
            An advice code from the payment gateway or network that indicates how to handle a card decline. For example, the value `try_again_later` means you can retry the transaction.
          maxLength: 100
          example: null
      example: null
    GatewayName:
      type: string
      deprecated: false
      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
      - payu
      - not_applicable
      example: null
    GatewayPaymentMethodToken:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 40
          example: null
        gateway_account_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        gateway_name:
          type: string
          deprecated: false
          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
          - payu
          - not_applicable
          example: null
        gateway_customer_id:
          type: string
          deprecated: false
          maxLength: 128
          example: null
        gateway_token:
          type: string
          deprecated: false
          maxLength: 256
          example: null
        status:
          type: string
          default: active
          deprecated: false
          enum:
          - active
          - inactive
          - pending_verification
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
      required:
      - created_at
      - gateway_account_id
      - gateway_name
      - gateway_token
      - id
      - status
      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: |
            When `true`
            , the claim happens automatically. When not passed, the default value in the site settings is used.
          example: null
        no_expiry:
          type: boolean
          deprecated: false
          description: |
            When `true`
            , indicates that the gift does not expire. Do not pass or pass as `false`
            when `auto_claim`
            is set.
          example: null
        claim_expiry_date:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The date until which the gift can be claimed. Must be set to a value after `scheduled_at`.
            If the gift is not claimed within `claim_expiry_date`
            , it will expire and the subscription will move to `cancelled`
            state. When not passed, the value specified in the site settings will be used.
            Pass as `NULL`
            or do not pass when `auto_claim`
            or `no_expiry`
            are set.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            Version number of this resource. The `resource_version`
            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.
          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
    GrantBlock:
      type: object
      description: "A grant block represents a bucket of issued credit grants associated\
        \ with a given subscription, `unit_id`, and `unit_type`, allocated either\
        \ through an [item price](/docs/api/item_prices) or via the [allocate](/docs/api/ledger_operations/allocate)\
        \ operation.\n\nEach grant block follows its own lifecycle, governed by a\
        \ defined policy that manages how the credit grants within the block are consumed,\
        \ held, expired or rolled over.  \n**Example**\n\nAn annual subscription plan\
        \ grants **100 AI credits every month** , resulting in a new grant block of\
        \ 100 credit grants being allocated to the subscription at the start of **each\
        \ grant cycle**.\n\nDuring its lifecycle, the block tracks usage through the\
        \ balance fields grouped under [**provisioned_block_balance**](#provisioned_block_balance)\
        \ and [**overdraft_block_balance**](#overdraft_block_balance) (for example,\
        \ `used_amount`, `hold_amount`, and `usable_balance`).\n\nSince the grant\
        \ frequency is monthly, each block has a **validity of one month** from its\
        \ [**effective_from**](#effective_from) time, after which it expires. If a\
        \ rollover policy is configured, any unused credit grants at [**expires_at**](#expires_at)\
        \ may be carried forward into a new grant block; otherwise, they expire.\n\
        \nThis process repeats each month as long as the subscription remains active,\
        \ creating a sequence of time-bound grant blocks that independently track\
        \ and manage their respective credit grants.\n\nGrant Blocks Lifecycle\n----------------------\n\
        \nscreenshot\\|/images/grant_blocks_lifecycle.png\n\nLifecycle Of Credit Grants\
        \ In A Block\n-------------------------------------\n\nscreenshot\\|/images/life_cycle_of_credits.png\n"
      properties:
        id:
          type: string
          deprecated: false
          description: "A unique identifier for this grant block.  \n**Behavior**\n\
            \n* Automatically assigned by the ledger at creation time.\n* Immutable\
            \ and cannot be modified once written.\n"
          maxLength: 50
          example: null
        subscription_id:
          type: string
          deprecated: false
          description: |
            Identifier of the subscription this grant block belongs to.
          maxLength: 50
          example: null
        unit_id:
          type: string
          deprecated: false
          description: |
            Identifier of the credit unit this block belongs to. For example, a credit unit id such as `ai_credits`.
          maxLength: 50
          example: null
        unit_type:
          type: string
          deprecated: false
          description: |
            Type of unit used for this balance. For example, `credit_unit` for credit grants.

            * credit_unit - The unit represents a credit unit, the type used by credit grants.
          enum:
          - credit_unit
          example: null
        account_type:
          type: string
          deprecated: false
          description: |
            The account this block belongs to: **provisioned** (credit grants issued per the plan, consumed first) or
            **overdraft** (consumption beyond the configured credit grants, after the provisioned account is exhausted).

            * provisioned -
              Stores the credit grants given as per the plan configuration. Consumption of credit grants is first done
              through this account.
            * overdraft -
              Allows consumption beyond the configured credit grants. Used once the credit grants in the provisioned account
              are exhausted.
          enum:
          - provisioned
          - overdraft
          example: null
        effective_from:
          type: integer
          format: unix-time
          deprecated: false
          description: "Unix timestamp (in seconds) indicating when this grant block\
            \ becomes active and its credits become available for use.  \n**Behavior**\n\
            \n* Allocations scheduled for the future are valid but remain non-spendable\
            \ until this time.\n* Prior to this timestamp, the block is in a scheduled\
            \ state.  \n**Activation**\n\nAt effective_from, the block becomes active\
            \ and its credits are included in the usable balance of the account. \
            \ \n**Note**\n\neffective_from is inclusive (bounded). Any capture operation\
            \ with a timestamp exactly equal to effective_from is eligible to consume\
            \ credits from this block.\n"
          example: null
        expires_at:
          type: integer
          format: unix-time
          deprecated: false
          description: "Unix timestamp (in seconds) indicating when this grant block\
            \ stops being directly consumable.  \n**Behavior**\n\n* At expires_at,\
            \ the block transitions from available to in_grace_period.\n* During the\
            \ grace period, eligible late-arriving operations may still consume credits\
            \ based on their operation_timestamp.  \n**Finalization**\nAfter the grace\
            \ period ends, any remaining balance is finalized as expired or rolled\
            \ over, depending on the configured rollover policy.  \n**Note**\n\nexpires_at\
            \ is exclusive (unbounded). Any capture operation with a timestamp exactly\
            \ equal to expires_at is not eligible to consume credits from this block.\n"
          example: null
        origin_grant_block_id:
          type: string
          deprecated: false
          description: "Identifier of the source (originating) grant block from which\
            \ this block was derived.  \n**Behavior**\n\n* Populated only when this\
            \ block is created through a rollover.\n* References the block whose remaining\
            \ balance was carried forward into this block.  \n**Usage**\n\nEnables\
            \ traceability between original and rollover blocks for audit and reporting\
            \ purposes.\n"
          maxLength: 50
          example: null
        status:
          type: string
          default: available
          deprecated: false
          description: "Enumerated string representing the current lifecycle state\
            \ of the grant block.  \n**Example**\n\nA block moves from scheduled →\
            \ available → in_grace_period → exhausted over its lifecycle.\n\n* available\
            \ - The block is effective and credit grants are consumable subject to\
            \ remaining balance and holds.\n* exhausted - No usable credit grants\
            \ remain; the block was fully consumed, expired, voided, or rolled over.\n\
            * in_grace_period -\n  Past `expires_at` but within the configured grace\
            \ period; limited consumption is still allowed for eligible\n  operations\
            \ (those whose `operation_timestamp` falls within the original validity\
            \ window).\n* scheduled - The block exists but `effective_from` is still\
            \ in the future, so credit grants are not yet spendable.\n"
          enum:
          - available
          - exhausted
          - scheduled
          - in_grace_period
          example: null
        grant_source:
          type: string
          deprecated: false
          description: |
            Enumerated string indicating the event or action that resulted in these credit grants being issued.

            * grant_renewal - Issued when a grant is renewed for the next cycle by the grant renewal process (recurring re-grant of the configured credits).
            * promotional_grants - Issued from the [allocate](/docs/api/ledger_operations/allocate) operation (for example, marketing offers or goodwill credits).
            * rollover - Issued by carrying forward unused credit grants from another block at end-of-period processing.
            * subscription_changed -
              Issued in response to a subscription change that triggers a new allocation (for example, a plan or addon
              update that adjusts the credit grants).
            * subscription_created - Issued when the subscription was created (initial allocation as per the plan configuration).
            * top_up - Issued from a top-up purchase or similar add-on credit-grant purchase made on top of the configured plan.
            * subscription_renewed - Issued when the subscription renews for a new term, triggering a fresh allocation of the configured credit grants.
          enum:
          - subscription_created
          - subscription_changed
          - top_up
          - promotional_grants
          - rollover
          - grant_renewal
          - subscription_renewed
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: "Unix timestamp (in seconds) indicating when this grant block\
            \ was recorded in the ledger.  \n**Behavior**\n\n* Automatically set by\
            \ the ledger at creation time.\n* Immutable and cannot be modified after\
            \ being written.  \n**Usage**\n\nProvides a reliable reference for auditability\
            \ and chronological ordering of grant blocks.\n"
          example: null
        modified_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Unix timestamp (seconds) when the grant block was last updated.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            Version number of this resource. The `resource_version` is updated with a new timestamp for every change made to the resource.
          example: null
        metadata:
          type: object
          additionalProperties: true
          deprecated: false
          description: "Optional opaque JSON object carrying additional business context\
            \  \n**Behavior**\n\n* Stored as-is and returned verbatim by the ledger.\n\
            * Not interpreted, validated, or indexed by the ledger.\n"
          example: null
        provisioned_block_balance:
          type: object
          deprecated: false
          description: "Balance details for a grant block with provisioned [`account_type`](#account_type).\
            \  \n**Note**\n\nPopulated only for blocks with provisioned `account_type`;\
            \ `null` for overdraft blocks.\n"
          properties:
            granted_amount:
              type: string
              deprecated: false
              description: "The total number of credit grants issued to this grant\
                \ block when it was created. This value represents the maximum credits\
                \ the block can provide over its lifetime.\nReturned as a decimal\
                \ string.  \n**Constraints**\n\nMaximum supported value: `9999999999999999999999999.9999999999`\
                \ (up to 25 digits before the decimal and up to 10 digits after).\n"
              maxLength: 36
              example: null
            total_balance:
              type: string
              deprecated: false
              description: "Total credits remaining in this grant block, including\
                \ held amounts (`usable_balance` + `hold_amount`). Returned as a decimal\
                \ string.  \n**Constraints**\n\nMaximum supported value: `9999999999999999999999999.9999999999`\
                \ (up to 25 digits before the decimal and up to 10 digits after).\n"
              maxLength: 36
              example: null
            usable_balance:
              type: string
              deprecated: false
              description: "Remaining usable credits in this grant block available\
                \ for consumption (excludes held amount). Returned as a decimal string.\
                \  \n**Constraints**\n\nMaximum supported value: `9999999999999999999999999.9999999999`\
                \ (up to 25 digits before the decimal and up to 10 digits after).\n"
              maxLength: 36
              example: null
            hold_amount:
              type: string
              deprecated: false
              description: "The portion of credit grants temporarily reserved by active\
                \ authorization operations on this block, which are not yet captured\
                \ or released. Returned as a decimal string.  \n**Constraints**\n\n\
                Maximum supported value: `9999999999999999999999999.9999999999` (up\
                \ to 25 digits before the decimal and up to 10 digits after).  \n\
                **Behavior**\nThese reserved credits are not considered consumed.\
                \ However, they are excluded from the remaining usable balance until\
                \ the authorization is either completed (captured) or canceled (released).\
                \  \n**Example**\n\nIf a block has 100 credits, with 20 used and 5\
                \ on hold, the `usable_balance` is 75 and `hold_amount` is 5.\n"
              maxLength: 36
              example: null
            used_amount:
              type: string
              deprecated: false
              description: "Total credits consumed from this block through consumption\
                \ operations (captures and capture authorizations). Returned as a\
                \ decimal string.  \n**Constraints**\n\nMaximum supported value: `9999999999999999999999999.9999999999`\
                \ (up to 25 digits before the decimal and up to 10 digits after).\n"
              maxLength: 36
              example: null
            expired_amount:
              type: string
              deprecated: false
              description: "The portion of credit grants in this block that expired\
                \ without being consumed, rolled over, or voided. Returned as a decimal\
                \ string.  \n**Constraints**\n\nMaximum supported value: `9999999999999999999999999.9999999999`\
                \ (up to 25 digits before the decimal and up to 10 digits after).\
                \  \n**Lifecycle Behavior**\n\n* The block becomes consumable at `effective_from`\
                \ and remains directly usable until `expires_at`.\n* After `expires_at`,\
                \ the block enters the configured grace period.\n* During this grace\
                \ period, late-arriving operations with an `operation_timestamp` within\
                \ the original validity window may still consume credits from this\
                \ block.  \n**Finalization**\n\nOnce the grace period ends, any remaining\
                \ unconsumed credits are finalized and recorded as `expired_amount`.\
                \  \n**Example**\n\nIf a block expires at 10:00 and has a 6-hour grace\
                \ period, a usage event with an `operation_timestamp` of 9:55 can\
                \ still consume credits during the grace window.\n"
              maxLength: 36
              example: null
            rolled_over_amount:
              type: string
              deprecated: false
              description: "The portion of credits carried forward from this block\
                \ into a new rollover block during end-of-period processing. Returned\
                \ as a decimal string.  \n**Constraints**\n\nMaximum supported value:\
                \ `9999999999999999999999999.9999999999` (up to 25 digits before the\
                \ decimal and up to 10 digits after).  \n**Source vs Destination Behavior**\n\
                \n* On the source block, this amount reflects the remaining balance\
                \ that has been moved out and is no longer spendable.\n* On the destination\
                \ (rollover) block, the same amount is recorded under `provisioned_block_balance.granted_amount`\
                \ as the value of the new block.  \n**Reporting Semantics**\n\nTracked\
                \ separately from `expired_amount` to clearly distinguish credits\
                \ that were preserved via rollover from those that expired.\n"
              maxLength: 36
              example: null
            voided_amount:
              type: string
              deprecated: false
              description: "The portion of credits removed from this block through\
                \ administrative void operations. Returned as a decimal string.  \n\
                **Constraints**\n\nMaximum supported value: `9999999999999999999999999.9999999999`\
                \ (up to 25 digits before the decimal and up to 10 digits after).\
                \  \n**Behavior**\n\n* Voided credits reduce the remaining usable\
                \ balance of the block.\n* They are not included in `used_amount`.\
                \  \n**Reporting Semantics**\n\nTracked separately to ensure usage\
                \ reports and revenue reconciliation exclude voided credits while\
                \ maintaining a complete audit trail.  \n**Example**\n\nIf 10 credits\
                \ are revoked due to a cancellation, they are added to `voided_amount`\
                \ and not counted as usage.\n"
              maxLength: 36
              example: null
          example: null
        overdraft_block_balance:
          type: object
          deprecated: false
          description: "Balance details for a grant block with overdraft [`account_type`](#account_type).\
            \  \n**Note**\n\nPopulated only for blocks with overdraft `account_type`;\
            \ `null` for provisioned blocks.\n"
          properties:
            is_unlimited:
              type: boolean
              default: false
              deprecated: false
              description: |
                Whether the overdraft block has no limit (`true`) or is capped (`false`). When `true`, `limit`, `total_balance`, and `usable_balance` are `null`.
              example: null
            limit:
              type: string
              deprecated: false
              description: "The maximum overdraft credits allowed for this block.\
                \ Returned as a decimal string; `null` when [`is_unlimited`](#overdraft_block_balance.is_unlimited)\
                \ is `true`.  \n**Constraints**\n\nMaximum supported value: `9999999999999999999999999.9999999999`\
                \ (up to 25 digits before the decimal and up to 10 digits after).\n"
              maxLength: 36
              example: null
            total_balance:
              type: string
              deprecated: false
              description: "Total overdraft credits remaining in this block, including\
                \ held amounts. Returned as a decimal string; `null` when [`is_unlimited`](#overdraft_block_balance.is_unlimited)\
                \ is `true`.  \n**Constraints**\n\nMaximum supported value: `9999999999999999999999999.9999999999`\
                \ (up to 25 digits before the decimal and up to 10 digits after).\n"
              maxLength: 36
              example: null
            usable_balance:
              type: string
              deprecated: false
              description: "Remaining usable overdraft credits in this block available\
                \ for consumption. Returned as a decimal string; `null` when [`is_unlimited`](#overdraft_block_balance.is_unlimited)\
                \ is `true`.  \n**Constraints**\n\nMaximum supported value: `9999999999999999999999999.9999999999`\
                \ (up to 25 digits before the decimal and up to 10 digits after).\n"
              maxLength: 36
              example: null
            used_amount:
              type: string
              deprecated: false
              description: "Total overdraft credits consumed from this block. Returned\
                \ as a decimal string.  \n**Constraints**\n\nMaximum supported value:\
                \ `9999999999999999999999999.9999999999` (up to 25 digits before the\
                \ decimal and up to 10 digits after).\n"
              maxLength: 36
              example: null
          required:
          - is_unlimited
          example: null
      required:
      - account_type
      - created_at
      - effective_from
      - expires_at
      - grant_source
      - id
      - modified_at
      - status
      - subscription_id
      - unit_id
      - unit_type
      example: null
    GrantBlocksCreatedEvent:
      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:
            grant_blocks:
              type: array
              items:
                $ref: "#/components/schemas/GrantBlock"
              example: null
          required:
          - grant_blocks
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    GrantBlocksUpdatedEvent:
      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:
            grant_blocks:
              type: array
              items:
                $ref: "#/components/schemas/GrantBlock"
              example: null
          required:
          - grant_blocks
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    GrantConfiguration:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        unit_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        unit_type:
          type: string
          deprecated: false
          enum:
          - feature
          - custom_pricing_unit
          example: null
        entity_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        entity_type:
          type: string
          deprecated: false
          enum:
          - plan_price
          - addon
          - addon_price
          - charge
          - charge_price
          example: null
        version:
          type: integer
          format: int64
          deprecated: false
          example: null
        change_reason:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        is_latest:
          type: boolean
          deprecated: false
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        created_by:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        created_at:
          type: integer
          format: int64
          deprecated: false
          example: null
        updated_by:
          type: string
          deprecated: false
          maxLength: 100
          example: null
      required:
      - entity_id
      - id
      - unit_id
      example: null
    GrantConfigurationOverride:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        subscription_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        unit_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        unit_type:
          type: string
          deprecated: false
          enum:
          - feature
          - custom_pricing_unit
          example: null
        entity_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        entity_type:
          type: string
          deprecated: false
          enum:
          - plan_price
          - addon
          - addon_price
          - charge
          - charge_price
          example: null
        is_enabled:
          type: boolean
          deprecated: false
          example: null
        grant_policies:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              amount:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              trigger_type:
                type: string
                deprecated: false
                enum:
                - interval
                - one_time
                example: null
              trigger_value:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              trigger_period_unit:
                type: string
                deprecated: false
                enum:
                - day
                - month
                - year
                example: null
              rollover_type:
                type: string
                default: none
                deprecated: false
                enum:
                - none
                - unlimited
                - time_limited
                - capped
                example: null
              rollover_cap_value:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              rollover_cap_type:
                type: string
                deprecated: false
                enum:
                - percentage
                - absolute
                example: null
              expiration_type:
                type: string
                default: none
                deprecated: false
                enum:
                - none
                - interval
                example: null
              expiration_value:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              expiration_period_unit:
                type: string
                deprecated: false
                enum:
                - day
                - month
                - year
                example: null
            required:
            - amount
            - expiration_type
            - id
            - rollover_type
            - trigger_type
            example: null
          example: null
        effective_from:
          type: object
          deprecated: false
          properties:
            type:
              type: string
              deprecated: false
              enum:
              - timestamp
              - event
              example: null
            value:
              type: string
              deprecated: false
              maxLength: 50
              example: null
          example: null
      required:
      - entity_id
      - entity_type
      - id
      - is_enabled
      - subscription_id
      - unit_id
      - unit_type
      example: null
    GrantConfigurationVersion:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        unit_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        unit_type:
          type: string
          deprecated: false
          enum:
          - feature
          - custom_pricing_unit
          example: null
        entity_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        entity_type:
          type: string
          deprecated: false
          enum:
          - plan_price
          - addon
          - addon_price
          - charge
          - charge_price
          example: null
        change_reason:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        version:
          type: integer
          format: int64
          deprecated: false
          example: null
        is_latest:
          type: boolean
          deprecated: false
          example: null
        created_by:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        created_at:
          type: integer
          format: int64
          deprecated: false
          example: null
        updated_by:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        updated_at:
          type: integer
          format: int64
          deprecated: false
          example: null
        grant_policies:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              amount:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              trigger_type:
                type: string
                deprecated: false
                enum:
                - interval
                - one_time
                example: null
              trigger_value:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              trigger_period_unit:
                type: string
                deprecated: false
                enum:
                - day
                - month
                - year
                example: null
              rollover_type:
                type: string
                default: none
                deprecated: false
                enum:
                - none
                - unlimited
                - time_limited
                - capped
                example: null
              rollover_cap_value:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              rollover_cap_type:
                type: string
                deprecated: false
                enum:
                - percentage
                - absolute
                example: null
              expiration_type:
                type: string
                default: none
                deprecated: false
                enum:
                - none
                - interval
                example: null
              expiration_value:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              expiration_period_unit:
                type: string
                deprecated: false
                enum:
                - day
                - month
                - year
                example: null
            required:
            - amount
            - expiration_type
            - id
            - rollover_type
            - trigger_type
            example: null
          example: null
      required:
      - entity_id
      - id
      - unit_id
      example: null
    Hierarchy:
      type: object
      description: "When a customer belongs to an [account hierarchy](https://www.chargebee.com/docs/2.0/account-hierarchy.html),\
        \ the `hierarchy` resource represents the customer's position within that\
        \ hierarchy. The hierarchy provides details about the customer's parent, children,\
        \ invoice owner, and payment owner.  \n**Note**\n\n* A customer can have a\
        \ maximum of 250 direct children.\n* The hierarchy allows a maximum of 5 levels\
        \ from the root node to the lowest child node.  \n**Related Endpoints**\n\n\
        * [Get hierarchy](/docs/api/customers/get-hierarchy)\n* [Update hierarchy\
        \ access settings](/docs/api/customers/update-hierarchy-access-settings-for-a-customer)\n\
        * [Link a customer to a hierarchy](/docs/api/customers/link-a-customer)\n\
        * [Delink a customer from a hierarchy](/docs/api/customers/delink-a-customer)\n"
      properties:
        customer_id:
          type: string
          deprecated: false
          description: |
            The `id`
            of the customer associated with this `hierarchy`
            resource.
          maxLength: 50
          example: null
        parent_id:
          type: string
          deprecated: false
          description: |
            The `id`
            of the immediate parent for the customer identified by `customer_id`.
            If the customer is the root of the hierarchy, this attribute isn't returned.
          maxLength: 50
          example: null
        payment_owner_id:
          type: string
          deprecated: false
          description: |
            The `id`
            of the customer responsible for paying the invoices for the customer identified by `customer_id`.
            This ID must match either `customer_id`
            or `invoice_owner_id`
            .
          maxLength: 50
          example: null
        invoice_owner_id:
          type: string
          deprecated: false
          description: |
            The `id`
            of the customer who receives the invoice for charges incurred by the customer identified by `customer_id`.
            This ID must match either `customer_id`
            or one of its ancestors.
          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: |
            A list of `id`
            s representing the immediate children, if any exist, for the customer identified by `customer_id`
            .
          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 way to integrate Chargebee with your website. For card payment methods, they help meet most of your PCI DSS compliance requirements. Chargebee offers hosted pages where your customers can perform the following actions:

        * [Checkout a new subscription](/docs/api/hosted_pages/create-checkout-for-a-new-subscription)
        * [Checkout changes to an existing subscription](/docs/api/hosted_pages/create-checkout-to-update-a-subscription)
        * [Manage payment sources](/docs/api/hosted_pages/manage-payment-sources)
        * [Make payments for all due invoices](/docs/api/hosted_pages/collect-now)
        * [Extending a subscription](/docs/api/hosted_pages/extend-subscription) When you create a hosted page, it is available at a secure and unique URL. This URL can then be provided to your customer on your website or by other means such as email. On successful completion of the hosted page workflow by the customer, they are redirected to the `redirect_url` with the hosted page `id` and `state` passed as query string parameters. As soon as the redirection happens, [retrieve the hosted page](/docs/api/hosted_pages/retrieve-a-hosted-page) to get details of the customer, subscription, invoice etc.

        #### Embedding a hosted page

        Only the [Checkout](/docs/api/hosted_pages/hosted-page-object#type) hosted page with the full-page [layout](/docs/api/hosted_pages/create-checkout-for-a-new-subscription#layout) supports embedding. To embed checkout in your website or application, use [embedded checkout](https://www.chargebee.com/docs/billing/2.0/hosted-capabilities/embedded-checkout.html) with Chargebee.js to mount checkout in a container on your page. Do not place hosted page URLs in your own [iframe](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/iframe) elements---Chargebee.js creates and manages the iframe for you.
      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.

            * accept_quote - Accept quote via hosted page
            * collect_now - Collect Unpaid Invoices for a Customer
            * checkout_new - Checkout new Subscription
            * extend_subscription - To extend a Subscription period
            * checkout_one_time - Checkout one time
            * 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
          enum:
          - checkout_new
          - checkout_existing
          - manage_payment_sources
          - collect_now
          - extend_subscription
          - 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: |
            This attribute allows you to store custom information with the `hosted_page` 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 [redirect URL](/docs/api/hosted_pages/create-checkout-for-a-new-subscription#redirect_url)'s query parameters. Using this ID, you can fetch the hosted page and perform actions related to the success of the marketing campaign.
          maxLength: 2048
          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: |
            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 [type](/docs/api/hosted_pages/hosted_page-object#type) of hosted page:

            * For `checkout_new`, `checkout_existing`, and `checkout_one_time`, the URL expires 3 hours after the page is created.
            * For `collect_now` and `manage_payment_sources`, the URL expires 5 days after creation.
          example: null
        layout:
          type: string
          deprecated: false
          description: "Specifies the [UI layout](https://www.chargebee.com/docs/billing/2.0/hosted-capabilities/hosted-checkout#ui-layout-options)\
            \ for the hosted page.  \nApplicable only when `type` is `checkout_new`,\
            \ `checkout_existing`, `checkout_one_time`, or `manage_payment_sources`.\n\
            \n* in_app - The hosted page is rendered in the in-app layout.\n* full_page\
            \ - The hosted page is rendered in the full-page layout.\n"
          enum:
          - in_app
          - full_page
          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: |
            The version number of this resource. For every change made to the resource, `resource_version`
            is updated with a new timestamp in milliseconds.
          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 unique ID of the [business entity](/docs/api/advanced-features)
            of this `hosted_page`.
          maxLength: 50
          example: null
        brand_id:
          type: string
          deprecated: false
          description: |
            The unique ID of the [brand](/docs/api/brands) this hosted page belongs to. Unless a brand was specified in the request, this is the brand of the customer or subscription the hosted page was created for.
          maxLength: 50
          example: null
      required:
      - content
      example: null
    ImpactedCustomer:
      type: object
      properties:
        action_type:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        download:
          type: object
          deprecated: false
          properties:
            download_url:
              type: string
              deprecated: false
              maxLength: 3500
              example: null
            valid_till:
              type: integer
              format: unix-time
              deprecated: false
              example: null
            mime_type:
              type: string
              deprecated: false
              maxLength: 100
              example: null
          required:
          - download_url
          - valid_till
          example: null
      example: null
    ImpactedItem:
      type: object
      description: |
        Item entitlements can change due to certain events in Chargebee. The impacted_items represents the items whose entitlements have changed owing to an event. It is returned as part of the content attribute of the webhook triggered by the event. The following events can contain the impacted_items resource:

        * A feature is created, activated, or deleted.
        * An item_entitlement is updated or removed.
        * An entitlement_override is auto-removed.

        **Note**

        impacted_items cannot be retrieved via API; the resource is sent to you only via webhooks.
      properties:
        count:
          type: integer
          format: int32
          deprecated: false
          description: |
            The total number of items that have been impacted.
          example: null
        items:
          type: array
          deprecated: false
          description: |
            The list of items that have been impacted. The objects in this array have the following keys:

            * `id`: (string, max chars = 100) The [unique identifier](/docs/api/items/item-object#id) for the item.
            * `type`: (enumerated string) The [type](/docs/api/items/item-object#type) of the item.

            This list can contain a maximum of 1,000 items. The full list of items is available in `download`.
          items:
            example: null
          example: null
        download:
          type: object
          deprecated: false
          description: |
            The [download](/docs/api/downloads)
            resource containing all the impacted items. The list of items is available as a JSON array in the file at `download.url`
            until `download.valid_till`
            .
          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: |
                The time until which the `download_url`
                is valid.
              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
      example: null
    ImpactedItemPrice:
      type: object
      properties:
        count:
          type: integer
          format: int32
          deprecated: false
          example: null
        item_prices:
          type: array
          deprecated: false
          items:
            example: null
          example: null
        download:
          type: object
          deprecated: false
          properties:
            download_url:
              type: string
              deprecated: false
              maxLength: 3500
              example: null
            valid_till:
              type: integer
              format: unix-time
              deprecated: false
              example: null
            mime_type:
              type: string
              deprecated: false
              maxLength: 100
              example: null
          required:
          - download_url
          - valid_till
          example: null
      example: null
    ImpactedSubscription:
      type: object
      description: |
        When certain [events](/docs/api/events) in Chargebee cause changes to [subscription entitlements](/docs/api/subscription_entitlements), the `impacted_subscriptions` resource indicates the affected subscriptions. This resource is part of the `content` attribute of the triggered [webhook](/docs/api/webhooks) for the following events:

        * When a `feature` is [created](/docs/api/events), [activated](/docs/api/events), or [deleted](/docs/api/events).
        * When an `item_entitlement` is [updated](/docs/api/events) or [removed](/docs/api/events).
        * When an `entitlement_override` is [updated](/docs/api/events), [removed](/docs/api/events), or [auto-removed](/docs/api/events).

        **Note**

        * Only a maximum of 100,000 subscription IDs are reported. [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 increase this limit for your Chargebee site.
        * You can't retrieve `impacted_subscriptions` through the API. Only webhooks send you this resource.
      properties:
        count:
          type: integer
          format: int32
          deprecated: false
          description: |
            The total count of affected subscriptions.
          example: null
        subscription_ids:
          type: array
          deprecated: false
          description: |
            The impacted subscription IDs. This list contains up to 1,000 IDs. The complete list of subscription IDs is in the `download`
            resource, which can store up to 100,000 IDs.
          items:
            example: null
          example: null
        download:
          type: object
          deprecated: false
          description: |
            This [download](/docs/api/downloads) resource contains the impacted subscription IDs. These IDs are in a JSON array in the file at `download.url` until `download.valid_till`. The file at this URL stores up to 100,000 subscription IDs. [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 increase this limit for your Chargebee site.
          properties:
            download_url:
              type: string
              deprecated: false
              description: |
                The download URL for the file.
              maxLength: 3500
              example: null
            valid_till:
              type: integer
              format: unix-time
              deprecated: false
              description: |
                The expiration time for the `download_url`
                .
              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
      example: null
    InAppSubscription:
      type: object
      description: "**Important:**\n\n* We've stopped giving access to the legacy\
        \ solution due to the limitations mentioned [here](https://www.chargebee.com/docs/billing/2.0/mobile-subscriptions/mobile-subscriptions-limitations).\
        \ Please [request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/omnichannel-subscription&ref=feature)\
        \ for enabling the new [Omnichannel Subscriptions](/docs/api/recorded_purchases/recorded-purchase-object)\
        \ solution.\n* 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.\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: |
            The `id`
            of the [subscription](/docs/api/subscriptions/subscription-object#id)
            for which the receipt was sent.
          maxLength: 100
          example: null
        customer_id:
          type: string
          deprecated: false
          description: |
            The `id`
            of the [customer](/docs/api/customers/customer-object#id)
            object to which the subscription belongs.
          maxLength: 100
          example: null
        plan_id:
          type: string
          deprecated: false
          description: |
            The
            `id`
            of the plan-item price of the subscription.
          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: |
            The `id`
            of the invoice generated in Chargebee
          maxLength: 100
          example: null
      required:
      - subscription_id
      example: null
    Invoice:
      type: object
      additionalProperties: true
      description: "An invoice is a commercial document representing a sale of products/services\
        \ offered by you to a customer. It enumerates all the charges, adjustments,\
        \ payments, discounts and taxes associated with the sale.\n\nAn invoice is\
        \ said to be a recurring one when it is has at least one charge for [a plan\
        \ or an addon item price](/docs/api/items). It is a non-recurring one when\
        \ it has charges for only charge-item prices or [one-time charges](https://www.chargebee.com/docs/2.0/charges.html).\n\
        \nThe item prices for any given billing term of a subscription are billed\
        \ via an invoice at the beginning of the term (unless the charges are left\
        \ unbilled). However, item prices that belong to `metered` items are billed\
        \ at the end of the term via a `pending` invoice that can [close automatically](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing)\
        \ or via [an API call](/docs/api/invoices/close-a-pending-invoice). Moreover,\
        \ when there are no `metered` items in the subscription, the invoices can\
        \ still be generated as `pending` while [creating](/docs/api/subscriptions/create-subscription-for-items)\
        \ or [updating](/docs/api/subscriptions/update-subscription-for-items) a subscription.\n\
        \n#### Auto-collection\n\nIf [auto-collection](https://www.chargebee.com/docs/2.0/customers.html#auto-collection-status)\
        \ is enabled, then immediately on invoice generation (or, in case of subscriptions\
        \ that have `create_pending_invoices` as `true`, on [invoice closure](/docs/api/invoices/close-a-pending-invoice)),\
        \ the [payment method](/docs/api/customers/customer-object#payment_method)\
        \ on file is charged:\n\n* If the payment succeeds, the invoice is marked\
        \ as `paid`.\n* On payment failure, the invoice is marked as `payment_due`\
        \ and [dunning settings](https://www.chargebee.com/docs/2.0/dunning-v2.html)\
        \ are taken into account for payment retries.\n* If no retry attempts are\
        \ configured, or when retries are exhausted, the invoice is marked as `not_paid`.\n\
        * the amount due is zero or negative, the invoice is immediately marked as\
        \ `paid` and the balance, if any, is added to [excess payments](https://www.chargebee.com/docs/2.0/customers.html#excess-payments)\
        \ for the customer.\n\n**Note:** If [consolidated invoicing](https://www.chargebee.com/docs/2.0/consolidated-invoicing.html)\
        \ is enabled, the attribute `subscription_id` is unavailable when the invoice\
        \ has line items from multiple subscriptions. The individual subscription\
        \ ids are seen under `line_items.subscription_id`.  \n\n#### Recurring and\
        \ non-recurring invoices\n\nA recurring invoice contains at least one line\
        \ item that is billed on a recurring basis. Specifically, it has at least\
        \ one [`line_items[]`](/docs/api/invoices/invoice-object#line_items) with\
        \ `entity_type` set to `plan_item_price` or `addon_item_price`. A non-recurring\
        \ invoice contains no recurring line items.  \n\n#### Refundable amount for\
        \ an invoice\n\nThe refundable amount for an invoice is the (amount paid on\
        \ the invoice + refundable credit applied on the invoice + taxes withheld\
        \ on the invoice) minus (amount issued as refundable credit notes from the\
        \ invoice). Each of these amounts is obtained from the invoice resource as\
        \ follows:\n\n* Amount paid on the invoice: [`amount_paid`](/docs/api/invoices/invoice-object#invoice_amount_paid)\n\
        * Refundable credit applied on the invoice: [`credits_applied`](/docs/api/invoices/invoice-object#invoice_credits_applied)\n\
        * Taxes withheld on the invoice: Sum of [`linked_taxes_withheld[].amount`](/docs/api/invoices/invoice-object#invoice_linked_taxes_withheld)\n\
        * Amount issued as refundable credit notes from the invoice: Sum of [`issued_credit_notes[i].cn_total`](/docs/api/invoices/invoice-object#invoice_issued_credit_notes)\
        \ where `issued_credit_notes[i].cn_status` is `refunded` or `refund_due`.\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: |
            The identifier of the subscription this invoice belongs to.
            **Note** :
            When consolidated invoicing is enabled, you have to refer to [line_item\`s](/docs/api/invoices/invoice-object#line_items)
            `subscription_id`
            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.
          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: |
            Current status of this invoice.

            * 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
            * pending -
              The [invoice](/docs/api/invoices/invoice-object#status) is yet to be closed (sent for payment collection). An invoice is generated with this `status` when it has line items that belong to items that are `metered` or when the `subscription.create_pending_invoices`attribute is set to `true`.
              The [invoice](/docs/api/v2/pcv-1/invoices/invoice-object#status) is yet to be closed (sent for payment collection). All invoices are generated with this `status` when [Metered Billing](https://www.chargebee.com/docs/1.0/metered_billing.html) is enabled for the site.
            * 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.
          enum:
          - paid
          - posted
          - payment_due
          - not_paid
          - voided
          - pending
          example: null
        date:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            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 `pending`
            , 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.
          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: |
            The number of days from [`invoice.date`](/docs/api/invoices/invoice-object#date) until payment for the invoice is due.
          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: |
            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 [line_items[]](/docs/api/invoices/invoice-object#line_items)`.amount`

            * the sum of all [line_item_discounts[]](/docs/api/invoices/invoice-object#line_item_discounts)`.discount_amount`.
          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: |
            The unpaid amount that is due on the invoice. This is calculated as: [total](/docs/api/invoices/invoice-object#total)

            * [amount_paid](/docs/api/invoices/invoice-object#amount_paid)
            * sum of [applied_credits](/docs/api/invoices/invoice-object#applied_credits)`.applied_amount`
            * sum of [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)`.cn_total`
            * sum of [linked_taxes_withheld](/docs/api/invoices/invoice-object#linked_taxes_withheld)`.amount`.
          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: |
            Payments collected successfully for the invoice. This is the sum of [linked_payments[]](/docs/api/invoices/invoice-object#linked_payments)`.txn_amount`
            for all `linked_payments[]`
            that have `txn_status`
            as `success`.
          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: |
            The version number of this resource. For every change made to the resource, `resource_version`
            is updated with a new timestamp in milliseconds.
          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: "This attribute is returned only if additional resources are\
            \ available. Use this value as the input parameter for `line_items_offset`\
            \ to retrieve the next set of resources.  \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"
          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: |
            The share of the invoice total due to new sales. When `first_invoice`
            is `true`
            , this attribute is the same as total. However, when the invoice is a [consolidated](https://www.chargebee.com/docs/2.0/consolidated-invoicing.html )
            one, then it is the sum of all `line_items.amount`
            belonging to a new.
          minimum: 0
          example: null
        has_advance_charges:
          type: boolean
          deprecated: false
          description: |
            Indicates whether an [advance charge](https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/advance-invoices) 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: |
            The date when the invoice is finalized. This is the date in the invoice lifecycle when its `status`
            becomes any one of the following for the first time: `payment_due`
            , `posted`
            , or `paid`.
            For an invoice with `status`
            as `pending`
            , this happens when it gets closed.
          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/invoices/pause-dunning-for-invoice) for the invoice.
            **See also** : [Dunning resumption process](/docs/api/invoices/resume-dunning-for-invoice).
          example: null
        amount_to_collect:
          type: integer
          format: int64
          deprecated: false
          description: |
            Payments that are yet to be collected for the invoice. This is determined as [`amount_due`](/docs/api/invoices/invoice-object#amount_due) - the sum of all [`linked_payments[txn_amount][i]`](/docs/api/invoices/invoice-object#linked_payments) where [`linked_payments[txn_status][i]`](/docs/api/invoices/invoice-object#linked_payments) is `in_progress`.
          minimum: 0
          example: null
        round_off_amount:
          type: integer
          format: int64
          deprecated: false
          description: |
            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 `round_off_amount`.
            If there is no `round-off amount`
            , it will display `0`
            .
          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: |
            An overridden value for the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number).
            Only applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)

            `country`
            as `XI`
            (which is **United Kingdom - Northern Ireland**
            ).

            When you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)
            in 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)
            the Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)

            `country`
            as `XI`.
            That's the code for **United Kingdom - Northern Ireland** .
            The first two characters of the VAT number in such a case is
            `XI`
            by default. However, if the VAT number was registered in UK, the value should be `GB`.
            Set
            `vat_number_prefix`
            to `GB`
            for such cases.
          maxLength: 10
          example: null
        channel:
          type: string
          deprecated: false
          description: "The subscription channel this object originated from and is\
            \ maintained in.\n\n* app_store -\n  The 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  The 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.  \n  In-App Subscriptions is currently in early\
            \ access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\n  for\
            \ more information.\n* web - The 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 unique ID of the [business entity](/docs/api/advanced-features)
            of this invoice. Depending on whether the invoice was created directly for a customer or for a subscription, this is the business entity of the [customer](/docs/api/invoices/invoice-object#customer_id)
            or the [subscription](/docs/api/invoices/invoice-object#subscription_id)
            respectively.
          maxLength: 50
          example: null
        brand_id:
          type: string
          deprecated: false
          description: |
            The unique ID of the [brand](/docs/api/brands) this invoice belongs to. Depending on whether the invoice was created directly for a customer or for a subscription, this is the brand of the customer or the subscription respectively. It is always inherited and cannot be set on the invoice itself.
          maxLength: 50
          example: null
        exchange_rates:
          type: array
          deprecated: false
          description: |
            List of exchange rates applied when converting invoice amounts to other currencies (such as VAT local currency and organization local currency). Each entry contains [`currency_code`](/docs/api/invoices/invoice-object#exchange_rates_currency_code) and [`rate`](/docs/api/invoices/invoice-object#exchange_rates_rate).

            The invoice currency is the base currency. When multiple rates target the same currency, only one entry is returned.

            This array is different from [`exchange_rate`](/docs/api/invoices/invoice-object#exchange_rate) in the response. An entry whose `currency_code` matches [`local_currency_code`](/docs/api/invoices/invoice-object#local_currency_code) uses the same rate as [`local_currency_exchange_rate`](/docs/api/invoices/invoice-object#local_currency_exchange_rate).

            This array is returned in the response only when the corresponding features are enabled.
          items:
            type: object
            deprecated: false
            properties:
              currency_code:
                type: string
                deprecated: false
                description: |
                  Target currency for the conversion (ISO 4217). The invoice currency is the base currency.
                maxLength: 3
                example: null
              rate:
                type: number
                format: decimal
                deprecated: false
                description: |
                  Exchange rate applied as: 1 `currency_code` = `rate` invoice currency.

                  For example, when the invoice currency is `USD`, `currency_code` is `INR`, and `rate` is `0.010448403`, then 1 INR = 0.010448403 USD.
                maximum: 1000000000
                minimum: 0.0000000010
                example: null
            required:
            - currency_code
            - rate
            example: null
          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/2.0/plans.html#pricing-models)
                  for this item price.

                  * 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: |
                  The decimal representation of the unit amount of the `line_item`.
                  The value is in major units of the currency. Returned when the `line_item`
                  is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 39
                example: null
              quantity_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the quantity of this line_item. Returned when the `line_item`
                  is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 33
                example: null
              amount_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the amount for the `line_item`
                  , in major units of the currency. Typically equals to `unit_amount_in_decimal`
                  x `quantity_in_decimal`.
                  Returned when [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                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
                description: |
                  Indicates whether the line item is for a metered item. If `true`, the item is metered; otherwise, it is non-metered.
                example: null
              is_percentage_pricing:
                type: boolean
                deprecated: false
                description: |
                  Indicates whether the line item is percentage-based.
                example: null
              reference_line_item_id:
                type: string
                deprecated: false
                description: |
                  The unique identifier of the invoice line item to which this credit note line item is related. This is the same as [invoice.line_items.id](/docs/api/invoices/invoice-object#line_items_id)
                  .
                maxLength: 40
                example: null
              description:
                type: string
                deprecated: false
                description: |
                  The name of this line item as displayed on the invoice. For catalog-backed line items, this is the item's invoice name. For adhoc one-time charges, this is the charge name provided at creation.
                maxLength: 250
                example: null
              entity_description:
                type: string
                deprecated: false
                description: |
                  Descriptive text for this line item displayed on the invoice, shown below the line item name. For catalog-backed line items, this is the item price description when configured. Can be overridden when creating one-time invoices via the [Create invoice for items and one-time charges](/docs/api/invoices/create-invoice-for-items-and-one-time-charges) operation.
                maxLength: 2000
                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
                  * 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
                enum:
                - adhoc
                - plan_item_price
                - addon_item_price
                - charge_item_price
                example: null
              tax_exempt_reason:
                type: string
                deprecated: false
                description: |
                  The reason due to which the line item price/amount is exempted from tax.

                  * tax_not_configured - If tax is not enabled for the site
                  * tax_not_configured_external_provider - If the tax is not configured for the country in 3rd party tax provider.
                  * customer_exempt - If the Customer is marked as Tax exempt
                  * region_non_taxable - 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
                  * product_exempt - If the Plan or Addon is marked as Tax exempt
                  * zero_value_item - 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.
                  * reverse_charge - If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only
                  * high_value_physical_goods - 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
                  * zero_rated - If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item
                  * export -
                    You are not registered for tax in the customer's region. This is also the reason code when both `billing_address`
                    and `shipping_address`
                    have not been provided for the customer and subscription respectively
                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
              proration_mode:
                type: string
                deprecated: false
                description: |
                  Proration mode for the line item.
                enum:
                - reset
                - delta
                - service_period_revision
                - adjusted_term
                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: |
                  The price of the tier if the charge model is a `stairtstep`
                  pricing , or the price of each unit in the tier if the charge model is `tiered`
                  /`volume`
                  pricing.
                minimum: 0
                example: null
              starting_unit_in_decimal:
                type: string
                deprecated: false
                description: |
                  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 `ending_unit_in_decimal`
                  of the next lower tier. Returned only when the `line_items.pricing_model`
                  is `tiered`
                  , `volume`
                  or `stairstep`
                  and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 33
                example: null
              ending_unit_in_decimal:
                type: string
                deprecated: false
                description: |
                  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 `starting_unit_in_decimal`
                  of the next higher tier. Returned only when the `line_items.pricing_model`
                  is `tiered`
                  , `volume`
                  or stairstep and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 33
                example: null
              quantity_used_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the quantity purchased from this tier. Returned when the `line_item`
                  is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 33
                example: null
              unit_amount_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the per-unit price for the tier when the `pricing_model`
                  is `tiered`
                  or `volume`.
                  When the `pricing_model`
                  is `stairstep`
                  , it is the decimal representation of the total price for `line_item`.
                  The value is in major units of the currency. Returned when the `line_item`
                  is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 40
                example: null
              pricing_type:
                type: string
                deprecated: false
                description: |
                  Pricing type for the tier.

                  * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                  * flat_fee -
                    Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                    pricing model, `pricing_type`
                    will be set to `flat_fee`
                    by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                  * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                enum:
                - per_unit
                - flat_fee
                - package
                example: null
              package_size:
                type: integer
                format: int32
                deprecated: false
                description: |
                  Package size for the tier when pricing type is `package`.
                  Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                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: |
                  The type of deduction and the amount to which it is applied.

                  * prorated_credits -
                    The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`
                    is `null`
                    in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)
                    .
                  * promotional_credits -
                    The deduction is due to a [promotional credit](/docs/api/promotional_credits)
                    applied to the invoice. The `entity_id`
                    is `null`
                    in this case.
                  * document_level_discount -
                    The deduction is due to a [discount](/docs/api/discounts)
                    applied to the invoice `sub_total`.
                    The discount `id`
                    is available as the `entity_id`.
                  * item_level_discount -
                    The deduction is due to a [discount](/docs/api/discounts)
                    applied to a line item of the invoice. The discount `id`
                    is available as the `entity_id`.
                  * document_level_coupon -
                    The deduction is due to a coupon applied to the invoice `sub_total`.
                    The coupon `id`
                    is available as `entity_id`
                    .
                  * item_level_coupon -
                    The deduction is due to a coupon applied to a line item of the invoice. The coupon `id`
                    is available as `entity_id`
                    .
                enum:
                - item_level_coupon
                - document_level_coupon
                - promotional_credits
                - prorated_credits
                - item_level_discount
                - document_level_discount
                example: null
              coupon_id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              entity_id:
                type: string
                deprecated: false
                description: |
                  When the deduction is due to a `coupon`
                  or a [discount](/docs/api/discounts)
                  , then this is the `id`
                  of the coupon or discount.
                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
                  * 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 the 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: |
                  The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
                  without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                  as `AZ`
                  (not `US-AZ`
                  ). For Tamil Nadu (India), set as `TN`
                  (not `IN-TN`
                  ). For British Columbia (Canada), set as `BC`
                  (not `CA-BC`
                  ). For Dubai (UAE), set as `DU`
                  (not `AE-DU`
                  ).
                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: |
                  The unique id of the line item that this deduction is for. Is required when `discounts[entity_type]`
                  is `item_level_coupon`
                  or `document_level_coupon`
                  .
                maxLength: 40
                example: null
              entity_type:
                type: string
                deprecated: false
                description: |
                  The type of deduction and the amount to which it is applied.

                  * prorated_credits -
                    The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`
                    is `null`
                    in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)
                    .
                  * item_level_discount -
                    The deduction is due to a [discount](/docs/api/discounts)
                    applied to a line item of the invoice. The discount `id`
                    is available as the `entity_id`.
                  * promotional_credits -
                    The deduction is due to a [promotional credit](/docs/api/promotional_credits)
                    applied to the invoice.
                  * document_level_discount -
                    The deduction is due to a [discount](/docs/api/discounts)
                    applied to the invoice `sub_total`.
                    The discount `id`
                    is available as the `entity_id`.
                  * item_level_coupon -
                    The deduction is due to a coupon applied to line item. The coupon `id`
                    is passed as `entity_id`
                    .
                  * document_level_coupon -
                    The deduction is due to a coupon applied to the invoice `sub_total`.
                    The coupon id is passed as `entity_id`
                    .
                enum:
                - item_level_coupon
                - document_level_coupon
                - promotional_credits
                - prorated_credits
                - item_level_discount
                - document_level_discount
                example: null
              discount_type:
                type: string
                deprecated: false
                description: |
                  The type of discount that is applied to the line item. Relevant only when `discounts[entity_type]`
                  is one of `item_level_discount`
                  , `item_level_coupon`
                  , `document_level_discount`
                  , or `document_level_coupon`

                  * percentage - when percentage is applied as discount
                  * fixed_amount - when amount is applied as discount
                enum:
                - fixed_amount
                - percentage
                example: null
              entity_id:
                type: string
                deprecated: false
                description: |
                  When the deduction is due to a `coupon`
                  or a [discount](/docs/api/discounts)
                  , then this is the `id`
                  of the coupon or discount.
                maxLength: 100
                example: null
              coupon_set_code:
                type: string
                deprecated: false
                description: |
                  The [coupon code](/docs/api/coupon_codes/coupon_code-object#code)
                  , if applicable, used to provide the discount. The [coupon.id](/docs/api/coupons/coupon-object#id)
                  is available in `entity_id`
                  .
                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: |
            Details of `tax_withheld`
            against this invoice.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  An auto-generated unique identifier for the tax withheld. The value starts with the prefix `tax_wh_`.
                  For example, `tax_wh_16BdDXSlbu4uV1Ee6`
                  .
                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: "The status of this transaction.\n\n* timeout - Transaction\
                  \ failed because of Gateway not accepting the connection.\n* late_failure\
                  \ - 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.\n\
                  * failure - Transaction failed. Refer the 'error_code' and 'error_text'\
                  \ fields to know the reason for failure\n* in_progress -\n  Transaction\
                  \ is being processed by the gateway. This typically happens for\
                  \ [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html)\n\
                  \  or, in case of cards, refund transactions. Such transactions\
                  \ can take 2-7 days to complete, depending on the gateway and payment\
                  \ method.\n* success - The transaction is successful.\n* voided\
                  \ - The transaction got voided or authorization expired at gateway.\n\
                  * needs_attention -\n  When connection with the Gateway gets terminated\
                  \ abruptly. For `needs_attention`\n  status Chargebee automatically\
                  \ reconcile the transaction for few gateways, for rest of the gateways\
                  \ you have to use the [Reconcile transaction API](/docs/api/transactions/reconcile-transaction).\n\
                  \  You can use this API to update the `id_at_gateway`\n  (Gateway\
                  \ Transaction ID) and `status`\n  for a [`needs_attention`](/docs/api/transactions/transaction-object#status)\n\
                  \  transaction to be reconciled at par with the gateway.  \n  [Learn\
                  \ more](https://www.chargebee.com/docs/payments/2.0/needs-attention-transactions.html)\n\
                  \  about `needs_attention`\n  transaction status\n"
                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: "The status of the transaction.\n\n* timeout - The transaction\
                  \ failed because the gateway did not accept the connection.\n* success\
                  \ - The transaction was successful.\n* in_progress -\n  The transaction\
                  \ is being processed by the gateway. This typically occurs for [direct\
                  \ debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html)\n\
                  \  or, for cards, refund transactions. Processing can take 2-7 days,\
                  \ depending on the gateway and payment method.\n* needs_attention\
                  \ -\n  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 [Reconcile transaction\
                  \ API](/docs/api/transactions/reconcile-transaction).\n  Use this\
                  \ API to update the `id_at_gateway`\n  (gateway transaction ID)\
                  \ and `status`.  \n  [Learn more](https://www.chargebee.com/docs/payments/2.0/needs-attention-transactions.html)\n\
                  \  about `needs_attention`\n  transactions.\n* late_failure - 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.\n* voided - The transaction was voided,\
                  \ or the authorization expired at the gateway.\n* failure -\n  The\
                  \ transaction failed. Refer to the `error_code`\n  and `error_text`\n\
                  \  fields for details about the failure.\n"
                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: |
                  The type of transaction.

                  * authorization -
                    The transaction is an authorization to capture the [amount](/docs/api/transactions/transaction-object#amount)
                    from the customer's [payment_source](/docs/api/payment_sources)
                    .
                  * refund -
                    The transaction is a refund that returns the [amount](/docs/api/transactions/transaction-object#amount)
                    to the customer's [payment_source](/docs/api/payment_sources)
                    .
                  * payment -
                    The transaction is a payment that captures the [amount](/docs/api/transactions/transaction-object#amount)
                    from the customer's [payment_source](/docs/api/payment_sources)
                    .
                  * payment_reversal - The transaction is a reversal of a previously captured payment.
                enum:
                - authorization
                - payment
                - refund
                - payment_reversal
                example: null
              amount_capturable:
                type: integer
                format: int64
                default: 0
                deprecated: false
                description: |
                  This is the part of the authorized `amount`
                  that is yet to be captured. The payment capture is recorded as a transaction of `type`
                  = `payment`.
                  Applicable only for a transaction of `type`
                  = `authorization`
                  .
                minimum: 0
                example: null
              authorization_reason:
                type: string
                deprecated: false
                description: |
                  Type of reason for the authorization transaction.

                  * verification - The transaction was created to verify the payment method.
                  * blocking_funds - The transaction was created to block funds from the payment method.
                  * scheduled_capture -
                    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 [linked_payments]()
                    .
                enum:
                - verification
                - blocking_funds
                - scheduled_capture
                example: null
            required:
            - 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
                - real_time_payments
                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: "The status of this transaction.\n\n* success - The transaction\
                  \ is successful.\n* needs_attention -\n  When connection with the\
                  \ Gateway gets terminated abruptly. For `needs_attention`\n  status\
                  \ Chargebee automatically reconcile the transaction for few gateways,\
                  \ for rest of the gateways you have to use the [Reconcile transaction\
                  \ API](/docs/api/transactions/reconcile-transaction).\n  You can\
                  \ use this API to update the `id_at_gateway`\n  (Gateway Transaction\
                  \ ID) and `status`\n  for a [`needs_attention`](/docs/api/transactions/transaction-object#status)\n\
                  \  transaction to be reconciled at par with the gateway.  \n  [Learn\
                  \ more](https://www.chargebee.com/docs/payments/2.0/needs-attention-transactions.html)\n\
                  \  about `needs_attention`\n  transaction status\n* failure - Transaction\
                  \ failed. Refer the 'error_code' and 'error_text' fields to know\
                  \ the reason for failure\n* voided - The transaction got voided\
                  \ or authorization expired at gateway.\n* in_progress -\n  Transaction\
                  \ is being processed by the gateway. This typically happens for\
                  \ [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html)\n\
                  \  or, in case of cards, refund transactions. Such transactions\
                  \ can take 2-7 days to complete, depending on the gateway and payment\
                  \ method.\n* timeout - Transaction failed because of Gateway not\
                  \ accepting the connection.\n* late_failure - 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.\n"
                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.
                  * flexpay - The attempt was processed by FlexPay Recovery.
                  * successplus - GoCardless Success Plus.
                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: |
                  Timestamp when the credit amount was 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: |
            The list of [notes](https://www.chargebee.com/docs/2.0/invoice_notes.html)
            that appear on the invoice PDF sent to the customer. Notes that come from a specific resource related to the invoice have `entity_type`
            and `entity_id`
            defined. There can be up to two notes in this array for which `entity_type`
            and `entity_id`
            are not defined:

            * **Invoice-specific note:** It is the note provided via the `invoice_note` parameter for various endpoints in the API that also create invoices. For example, [creating a subscription](/docs/api/subscriptions/create-subscription-for-items#invoice_notes), [creating an invoice](/docs/api/invoices/create-invoice-for-items-and-one-time-charges), and [closing a pending invoice](/docs/api/invoices/close-a-pending-invoice#invoice_note).
            * **General note:** This note is added to all invoices of the Chargebee site. You can [add/edit](https://www.chargebee.com/docs/invoice_notes.html#adding-general-notes) this note in the Chargebee admin console.
          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.
                  * 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
                  * 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:
                - 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: |
                The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
                without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                as `AZ`
                (not `US-AZ`
                ). For Tamil Nadu (India), set as `TN`
                (not `IN-TN`
                ). For British Columbia (Canada), set as `BC`
                (not `CA-BC`
                ). For Dubai (UAE), set as `DU`
                (not `AE-DU`
                ).
              maxLength: 50
              example: null
            state:
              type: string
              deprecated: false
              description: |
                The state/province name.
              maxLength: 50
              example: null
            country:
              type: string
              deprecated: false
              description: "The billing address country of the customer. Must be one\
                \ of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                .\n\n**Note**:\nIf you enter an invalid country code, the system will\
                \ return an error.  \n**Brexit**\n\nIf you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                \ the Brexit configuration, then `XI` (the code for **United Kingdom\
                \ - Northern Ireland**) is available as an 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://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: |
                The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
                without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                as `AZ`
                (not `US-AZ`
                ). For Tamil Nadu (India), set as `TN`
                (not `IN-TN`
                ). For British Columbia (Canada), set as `BC`
                (not `CA-BC`
                ). For Dubai (UAE), set as `DU`
                (not `AE-DU`
                ).
              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 country of the customer. Must be one\
                \ of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                .\n\n**Note**:\nIf you enter an invalid country code, the system will\
                \ return an error.  \n**Brexit**\n\nIf you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                \ the Brexit configuration, then `XI` (the code for **United Kingdom\
                \ - Northern Ireland**) is available as an 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://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: |
                The unique `id`
                for the e-invoice. This is auto-generated by Chargebee.
              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: |
                The status of processing the e-invoice. To obtain detailed information about the current `status`
                , see `message`
                .

                * under_query - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.
                * 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.
                * paid - The receiving entity has confirmed that the e-invoice has been paid.
                * skipped -
                  The e-invoice was not sent. This could be due to missing information or because the `entity_identifier`
                  is not registered on the e-invoicing network.
                * failed - The e-invoice was sent and there was an error due to which it was not delivered.
                * in_progress - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.
                * message_acknowledgement - An acknowledgment confirming that the application response was successfully received by the receiving entity.
                * scheduled - Sending the e-invoice to the customer has been scheduled.
                * conditionally_accepted - The e-invoice has been accepted with conditions.
                * accepted - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.
                * success - The e-invoice has been successfully delivered to the customer.
                * in_process - The e-invoice is currently being processed by the receiving entity.
                * registered - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.
              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: |
                Detailed information about the status of the e-invoice. When `status`
                is `skipped`
                or `failed`
                , this contains the reason or error details. The following are some valid examples:

                * Invoice successfully sent to customer via the e-invoicing network 9090:123456
                * Invoice successfully sent to customer via email id abc@acme.com
              maxLength: 3000
              example: null
            provider_references:
              type: array
              deprecated: false
              description: |
                List of key-value pairs from the e-invoicing provider (e.g. Receipt Message ID).
              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. Includes `currency_code` (ISO 4217): the currency of the organisation address country at creation time.
              example: null
          example: null
      required:
      - currency_code
      - customer_id
      - deleted
      - id
      - is_gifted
      - price_type
      - recurring
      - status
      - sub_total
      - tax
      - term_finalized
      example: null
    InvoiceAction:
      type: string
      deprecated: false
      enum:
      - void
      - write_off
      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: 2000
                example: null
              entity_type:
                type: string
                deprecated: false
                enum:
                - adhoc
                - plan_item_price
                - addon_item_price
                - charge_item_price
                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
              proration_mode:
                type: string
                deprecated: false
                enum:
                - reset
                - delta
                - service_period_revision
                - adjusted_term
                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
                - item_level_discount
                - document_level_discount
                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
                - item_level_discount
                - document_level_discount
                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
    Item:
      type: object
      additionalProperties: true
      description: |
        When offering subscriptions of products or services, each entity that is made available for sale is represented by an "item" object. Items therefore represent the various plans, addons or charges that you offer as part of your product catalog. Non-`metered` items are charged upfront in Chargebee, while `metered` items are charged at the end of the billing cycle, based on usage.

        ### Types of Items

        There are three types of items and they're listed and explained here. Examples for each type are provided in the table that follows.

        #### Plan-items or Plans

        Plan-items are items that have a recurring charge and are an essential component of any [subscription](/docs/api/subscriptions). Typically, plans represent a principal or key product or service in your catalog. They are charged at recurring intervals and often have other products or services offered along with them as addons and charges.

        #### Addon-items or Addons

        Addon-items are items that are sold along with a plan and are charged for at recurring intervals.

        #### Charge-items or Charges

        Charge-items are items that are sold along with a plan but charged once (or each time) a specified event occurs. A charge can also be [applied to a customer](/docs/api/v2/pcv-1/invoices/create-invoice-for-a-one-time-charge) without attaching to a subscription.

        #### Examples

        To help understand each type of item better, listed below are some examples of items from different business domains:

        ##### Non-Metered (SaaS)

        * **Item Family:** A project management solution.
        * **Plans:**
          * A "basic" plan offering a small set of features.
          * A "business" plan offering a larger set of features.
        * **Addons:**
          * An analytics plugin that is available only with the "business" plan.
          * A reporting plugin, available with both the above plans.
        * **Charges:**
          * Implementation charges.
          * Trial charges.

        ##### Non-Metered (E-commerce)

        * **Item Family:** A printed news magazine.
        * **Plans:**
          * Periodic issues of the magazine.
          * Periodic issues of the magazine, with digital content.
        * **Addons:**
          * Supplementary online content.
          * Access to a year's worth of back issues.
          * Searchable access to all back issues.
        * **Charges:**
          * Special edition books that are published every so often.

        ##### Metered

        * **Item Family:** SMS delivery services.
        * **Plans:**
          * A basic plan of up to 100K messages @ $0.03 per message.
          * A volume plan of 2M messages @ $0.01 per message.
        * **Addons:**
          * An addon of 50K MMS messages @ $0.1 per message.
          * Instant messaging.
        * **Charges:**
          * Automated Metered Billing is not applicable for charges.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            The identifier for the item. It is unique and immutable.
          maxLength: 100
          example: null
        name:
          type: string
          deprecated: false
          description: |
            A unique display name for the item. This is visible only in Chargebee and not to customers.
          maxLength: 100
          example: null
        external_name:
          type: string
          deprecated: false
          description: |
            A unique display name for the item.
          maxLength: 100
          example: null
        description:
          type: string
          deprecated: false
          description: "Description of the item. This is visible only in Chargebee\
            \ and not to customers.  \n**Note**:\n\n* The description field supports\
            \ up to 2000 characters, including HTML tags. The inner text (excluding\
            \ HTML tags) must not exceed 500 characters. For example: `- testing -\
            \ desc `. Total with tags: 38 characters, inner text: 'testing desc' (12\
            \ characters).\n* If your input includes characters requiring sanitization,\
            \ such as incomplete HTML tags, the sanitization process may alter the\
            \ input and increase its length. If the sanitized content exceeds the\
            \ allowed limit, the request will be rejected.\n"
          maxLength: 2000
          example: null
        status:
          type: string
          deprecated: false
          description: |
            The status of the item.

            * archived - The item is no longer active and no new item prices can be created
            * active - The item can be used to create new item prices.
            * deleted -
              Indicates that the item has been [deleted](/docs/api/items/delete-an-item).
              The `id`
              and `name`
              can be reused. Deleted items can be retrieved using [List items](/docs/api/items/list-items)
              .
          enum:
          - active
          - archived
          - deleted
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            The version number of this resource. For every change made to the resource, `resource_version`
            is updated with a new timestamp in milliseconds.
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when the item was last updated.
          example: null
        item_family_id:
          type: string
          deprecated: false
          description: |
            The `id`
            of the [Item family](/docs/api/item_families)
            that the item belongs to. Is mandatory when [Product Families](https://www.chargebee.com/docs/2.0/product-families.html)
            have been enabled.
          maxLength: 100
          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
        is_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: |
            If `enabled_for_checkout`
            , then the URL to be redirected to once the checkout is complete. This attribute is only available for plan-items.
          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.
            **Note:**
            Only the in-app layout of Checkout is supported.
          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: |
            The item is included in MRR calculations for your site. This attribute is only applicable for items of `type = charge`
            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 `false`
            .
          example: null
        item_applicability:
          type: string
          default: all
          deprecated: false
          description: |
            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 [Create](/docs/api/attached_items/create-an-attached-item)
            or [Update an attached item](/docs/api/attached_items/update-an-attached-item)
            API.

            * all - all addon-items and charge-items are applicable to this plan-item.
            * restricted -
              only the addon-items or charge-items provided in `applicable_items`
              can be applied to this plan-item.
          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
        metered:
          type: boolean
          default: false
          deprecated: false
          description: |
            Specifies whether the item undergoes metered billing. When `true`, the quantity is calculated from [usage records](/docs/api/usages). When `false`, the `quantity` is as determined while adding an item price to the subscription. Applicable only for items of `type` `plan` or `addon` and when [Metered Billing](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing) is enabled. The value of this attribute cannot be changed.
          example: null
        usage_calculation:
          type: string
          deprecated: false
          description: |
            How the quantity is calculated from usage data for the item prices belonging to this item. Only applicable when the item is `metered`.
            This value overrides the one [set at the site level](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing)
            .

            * sum_of_usages -
              the net quantity is the sum of the `quantity`
              of all usages for the current term.
            * last_usage -
              from among the usage records for the [item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
              with `usage_date`
              within the relevant billing period, the `quantity`
              of the usage record with the most recent `usage_date`
              is taken as the net quantity consumed.
            * max_usage -
              from among the usage records for the [item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
              with `usage_date`
              within the relevant billing period, the `quantity`
              of the usage record with the maximum value is taken as the net quantity consumed.
          enum:
          - sum_of_usages
          - last_usage
          - max_usage
          example: null
        is_percentage_pricing:
          type: boolean
          default: false
          deprecated: false
          description: |
            Indicates whether the pricing is percentage-based.
          example: null
        archived_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this item was archived.
          example: null
        channel:
          type: string
          deprecated: false
          description: "The subscription channel this object originated from and is\
            \ maintained in.\n\n* app_store -\n  The 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* web - The object was created (and is maintained)\
            \ for the web channel directly in Chargebee via API or UI.\n* play_store\
            \ -\n  The 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.  \n  In-App Subscriptions is currently in early\
            \ access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\n  for\
            \ more information.\n"
          enum:
          - web
          - app_store
          - play_store
          example: null
        metadata:
          type: object
          additionalProperties: true
          deprecated: false
          description: |
            A collection of key-value pairs that provides extra information about the item. [Learn more](/docs/api/advanced-features#metadata)
            .
          example: null
        deleted:
          type: boolean
          deprecated: false
          description: |
            Indicates whether the item has been deleted or not.
          example: null
        business_entity_id:
          type: string
          deprecated: false
          description: |
            The unique ID of the [business entity](/docs/api/business_entities)
            of this item. This is applicable only when multiple business entities have been created for the site. The value of this attribute indicates that the resource is specific to the given business entity.
          maxLength: 50
          example: null
        applicable_items:
          type: array
          deprecated: false
          description: |
            The list of addons and charges that are allowed to be applied to the plan. This attribute is applicable only for plan-items and that too when `item_applicability`
            is `restricted`
            .

            Other details of attaching items can be specified using the [Create](/docs/api/attached_items/create-an-attached-item)
            or [Update an attached item](/docs/api/attached_items/update-an-attached-item)
            API.
          items:
            type: object
            deprecated: false
            properties:
              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
            example: null
          example: null
        bundle_items:
          type: array
          deprecated: false
          description: |
            The list of items(plans, addons, and charges) added to the bundle plan. This attribute is only available when the [item_type](/docs/api/items/item-object#type)
            is `plan`
            .
          items:
            type: object
            deprecated: false
            properties:
              item_id:
                type: string
                deprecated: false
                description: |
                  The ID of the item(plan, addon, or charge) associated with this bundle.
                  **Note:**
                  At least one plan item must be associated with this bundle.
                maxLength: 100
                example: null
              item_type:
                type: string
                deprecated: false
                description: |
                  Type of item

                  * addon - A recurring component that can be added to a bundle plan.
                  * charge - A non-recurring component that can be added to a bundle plan.
                  * plan -
                    An essential component of the bundle plan.
                    **Note:**
                    At least one plan item should be associated with the bundle.
                enum:
                - plan
                - addon
                - charge
                example: null
              quantity:
                type: integer
                format: int32
                default: 1
                deprecated: false
                description: |
                  Quantity of the item(plan, addon, and charge) associated with the bundle.
                minimum: 1
                example: null
              price_allocation:
                type: number
                format: decimal
                deprecated: false
                description: |
                  Price allocation of the item(plan, addon, and charge) associated with the bundle.
                maximum: 100
                minimum: 0
                example: null
            required:
            - item_id
            example: null
          example: null
        bundle_configuration:
          type: object
          deprecated: false
          description: |
            This attribute holds additional information about the bundle item. This attribute is only available when the [item_type](/docs/api/items/item-object#type)
            is `plan`
            .
          properties:
            type:
              type: string
              deprecated: false
              description: |
                Type of the bundle

                * fixed -
                  Fixed `bundle_configuration.type`
                  appears when you create a bundle plan that cannot be updated during checkout or subscription creation.
              enum:
              - fixed
              example: null
          example: null
      required:
      - deleted
      - enabled_for_checkout
      - enabled_in_portal
      - id
      - is_giftable
      - metered
      - name
      - type
      example: null
    ItemBillingMetric:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        customer_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        contract_term_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        item_price_id:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        unit_amount_per_billing_cycle:
          type: integer
          format: int64
          deprecated: false
          minimum: 0
          example: null
        quantity_per_billing_cycle:
          type: integer
          format: int32
          deprecated: false
          minimum: 1
          example: null
        effective_from:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        effective_to:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        total_contract_value:
          type: integer
          format: int64
          default: 0
          deprecated: false
          minimum: 0
          example: null
        total_tax_amount:
          type: integer
          format: int64
          default: 0
          deprecated: false
          minimum: 0
          example: null
        total_discount_amount:
          type: integer
          format: int64
          default: 0
          deprecated: false
          minimum: 0
          example: null
        mrr:
          type: integer
          format: int64
          deprecated: false
          minimum: 0
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        modified_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        subscription_id:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        currency_code:
          type: string
          deprecated: false
          maxLength: 3
          example: null
        invoice_level_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
        contract_start:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        contract_end:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        contract_created_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
      required:
      - created_at
      - currency_code
      - customer_id
      - effective_from
      - effective_to
      - id
      - item_price_id
      - modified_at
      - quantity_per_billing_cycle
      - total_contract_value
      - total_discount_amount
      - total_tax_amount
      - unit_amount_per_billing_cycle
      example: null
    ItemCreatedEvent:
      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:
            item:
              $ref: "#/components/schemas/Item"
          required:
          - item
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    ItemDeletedEvent:
      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:
            item:
              $ref: "#/components/schemas/Item"
          required:
          - item
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    ItemEntitlement:
      type: object
      description: "**Deprecated**\n\nThe Item Entitlements API is deprecated and\
        \ no longer maintained. Migrate your integration to [Entitlements API](/docs/api/entitlements).\
        \  \n**Warning**\n\nAPI operations listed on this page are not supported when\
        \ [grandfathering](/docs/api/entitlements) is enabled.\n\n[Items](/docs/api/items)\
        \ represent the products or services that you offer to your customers. Items\
        \ often differ from each other in the product [features](/docs/api/features)\
        \ that are available in them. An item entitlement object represents the entitlement\
        \ an item has towards a feature. An item can have multiple such entitlements,\
        \ each corresponding to a unique feature it is entitled to.\nItem entitlements\
        \ can be created while [creating a feature](/docs/api/features/create-a-feature).\
        \ All subscriptions containing an item also [inherit](/docs/api/subscription_entitlements)\
        \ its entitlements.\n"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            A unique identifier for the `item_entitlement`.
            This is auto-generated.
          maxLength: 100
          example: null
        item_id:
          type: string
          deprecated: false
          description: |
            The `id`
            of the `item`
            to which this entitlement belongs.
          maxLength: 100
          example: null
        item_type:
          type: string
          deprecated: false
          description: |
            The `type`
            of the `item`
            to which this entitlement belongs.

            * charge - Charge
            * item - Item
            * subscription - Subscription
            * addon - Addon
            * plan - Plan
          enum:
          - plan
          - addon
          - charge
          - subscription
          - item
          example: null
        feature_id:
          type: string
          deprecated: false
          description: |
            The `id`
            of the feature towards which this entitlement has been granted.
          maxLength: 50
          example: null
        feature_name:
          type: string
          deprecated: false
          description: |
            The `name`
            of the `feature`
            towards which this entitlement has been granted.
          maxLength: 50
          example: null
        value:
          type: string
          deprecated: false
          description: |+
            The level of entitlement that the item has towards the feature. The possible values depend on the value of `feature.type`
            :

            * When `feature.type` is `quantity` and:

            * If `feature.levels[is_unlimited]` is not `true` for any one of `feature.levels[]`, then the value can be any one of `feature.levels[value][]`.

            * If `feature.levels[is_unlimited]` is `true` for one of the `feature.levels[]`, then the value can also be:

              * any one of `feature.levels[value][]`
              * or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.
            * When `type` is `range` and:

            * If `feature.levels[is_unlimited]` is not `true` for any one of `feature.levels[]`, then the value can be any whole number between `levels[value][0]` and `levels[value][1]` (inclusive).

            * If `feature.levels[is_unlimited]` is `true` for one of the `feature.levels[]`, then the value can be:

              * any whole number equal to or greater than `levels[value][0]`
              * or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.
            * When `type` is `custom`, then the value can be any one of `feature.levels[value][]`.

            * When `type` is `switch`, then the value is set as `available` or `true`.

          maxLength: 50
          example: null
        name:
          type: string
          deprecated: false
          description: |
            The display name for the entitlement level. The default values are auto-generated based on `feature.type` as follows:

            * When `feature.type` is `quantity` or `range`, then `name` is the space-separated concatenation of `value` and the pluralized version of `feature.unit`. For example, if `value` is `20` and `feature.unit` is `user`, then `name` becomes `20 users`.
            * When `feature.type` is `custom`, then `name` is the same as `value`.
            * When `feature.type` is `switch`, the `name` is set to `Available` when `value` is `true`; it's set to `Not Available` when `value` is `false`.
          maxLength: 50
          example: null
      required:
      - id
      example: null
    ItemEntitlementsRemovedEvent:
      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:
            feature:
              $ref: "#/components/schemas/Feature"
            metadata:
              $ref: "#/components/schemas/Metadata"
            impacted_item:
              $ref: "#/components/schemas/ImpactedItem"
            impacted_subscription:
              $ref: "#/components/schemas/ImpactedSubscription"
          required:
          - feature
          - impacted_item
          - impacted_subscription
          - metadata
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    ItemEntitlementsUpdatedEvent:
      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:
            feature:
              $ref: "#/components/schemas/Feature"
            metadata:
              $ref: "#/components/schemas/Metadata"
            impacted_item:
              $ref: "#/components/schemas/ImpactedItem"
            impacted_subscription:
              $ref: "#/components/schemas/ImpactedSubscription"
          required:
          - feature
          - impacted_item
          - impacted_subscription
          - metadata
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    ItemFamily:
      type: object
      additionalProperties: true
      description: "If you're a company that sells multiple product lines then each\
        \ product line or service is an item family in the Chargebee API. For example,\
        \ if you are a SaaS company that offers separate products for project management,\
        \ content collaboration, and customer support. Each of those can be an item\
        \ family under which the various plans, addons and charges can be the [items](/docs/api/items).\n\
        Item families compartmentalize items such that only items belonging to the\
        \ same family can be part of any given subscription.  \n**Note:**\n\nYou must\
        \ have the [Product Families](https://www.chargebee.com/docs/2.0/product-families.html)\
        \ enabled for your site to be able to set up item families.\n"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            The identifier for the item family. It is unique and immutable.
          maxLength: 50
          example: null
        name:
          type: string
          deprecated: false
          description: |
            A unique display name for the item family. This is visible only in Chargebee and not to customers.
          maxLength: 50
          example: null
        description:
          type: string
          deprecated: false
          description: |
            Description of the item family. This is visible only in Chargebee and not to customers.
          maxLength: 500
          example: null
        status:
          type: string
          deprecated: false
          description: |
            Status of the item family.

            * active - The item family is active and can be used to create new items.
            * deleted -
              The item family has been deleted and cannot be used to create new items. The `id`
              and `name`
              can be reused to create a new item family.
          enum:
          - active
          - deleted
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            The version number of this resource. For every change made to the resource, `resource_version`
            is updated with a new timestamp in milliseconds.
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            When the item family was last updated.
          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
        business_entity_id:
          type: string
          deprecated: false
          description: |
            The unique ID of the
            [business entity](/docs/api/business_entities)
            of this `item_family`.
            This is applicable only when multiple business entities have been created for the site. The value of this attribute indicates that the resource is specific to the given business entity.
          maxLength: 50
          example: null
        deleted:
          type: boolean
          deprecated: false
          description: |
            Indicates whether the item family has been deleted or not.
          example: null
      required:
      - deleted
      - id
      - name
      example: null
    ItemFamilyCreatedEvent:
      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:
            item_family:
              $ref: "#/components/schemas/ItemFamily"
          required:
          - item_family
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    ItemFamilyDeletedEvent:
      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:
            item_family:
              $ref: "#/components/schemas/ItemFamily"
          required:
          - item_family
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    ItemFamilyUpdatedEvent:
      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:
            item_family:
              $ref: "#/components/schemas/ItemFamily"
          required:
          - item_family
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    ItemPrice:
      type: object
      additionalProperties: true
      description: |
        An item price is a price point for an item. It defines the currency, pricing model, price, billing period and other attributes for an [item](/docs/api/items). For example, consider a cloud storage service as an item. Then each of the following defines an item price:

        * The cloud storage sold at USD 10 per month.

        * The same service sold at AUD 100 per year.

        * The service sold at a monthly rate determined by the following [stairstep](https://www.chargebee.com/docs/2.0/plans.html#pricing-models) pricing model:

          * 1-10 users for EUR 10
          * 11-25 users for EUR 20
          * 26-50 users for EUR 45
          * 51 and above for EUR 100

        Types of item prices
        --------------------

        The type of an item price corresponds to the [type of the item](/docs/api/items) that the item price belongs to. In other words, item prices can be of the following types:

        * Plan-item prices
        * Addon-item prices
        * Charge-item prices

        Billing periods for item prices
        -------------------------------

        The **billing period** of an item price (applicable only to plan-item prices and addon-item prices) is the [`period`](/docs/api/item_prices/item-price-object#period) of the item price in [`period_unit`](/docs/api/item_prices/item-price-object#period_unit)s.

        * When [price variants](/docs/api/price_variants) are **not** enabled, an item can have only one item price for a given currency and billing period.
        * When price variants **are** enabled, an item can have multiple item prices for the same currency and billing period, as long as each has a distinct [`price_variant_id`](/docs/api/item_prices/item-price-object#price_variant_id). An item price created without a `price_variant_id` is treated as the default ("no variant"), and only one such default item price can exist for a given currency and billing period.
      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: |
            A unique display name for the item price in the Chargebee UI. If `external_name`
            is not provided, this is also used in customer-facing pages and documents such as [invoices](/docs/api/invoices)
            and [hosted pages](/docs/api/hosted_pages)
            .
          maxLength: 100
          example: null
        item_family_id:
          type: string
          deprecated: false
          description: |
            Id of the item_family
          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.  \n**Note**:\n\n* The description\
            \ field supports up to 2000 characters, including HTML tags. The inner\
            \ text (excluding HTML tags) must not exceed 500 characters. For example:\
            \ `- testing - desc `. Total with tags: 38 characters, inner text: 'testing\
            \ desc' (12 characters).\n* If your input includes characters requiring\
            \ sanitization, such as incomplete HTML tags, the sanitization process\
            \ may alter the input and increase its length. If the sanitized content\
            \ exceeds the allowed limit, the request will be rejected.\n"
          maxLength: 2000
          example: null
        status:
          type: string
          deprecated: false
          description: |
            The status of the item price.

            * archived - 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.
            * active - The item price can be used in subscriptions.
            * deleted -
              Indicates that the item price has been deleted. The `id`
              and `name`
              can be reused.
          enum:
          - active
          - archived
          - deleted
          example: null
        external_name:
          type: string
          deprecated: false
          description: |
            The name of the item price used in customer-facing pages and documents. These include [invoices](/docs/api/invoices)
            and [hosted pages](/docs/api/hosted_pages).
            If not provided, then `name`
            is used
          maxLength: 100
          example: null
        price_variant_id:
          type: string
          deprecated: false
          description: |
            An immutable unique identifier of a [price variant](/docs/api/price_variants).
          maxLength: 100
          example: null
        proration_type:
          type: string
          deprecated: false
          description: |
            **Note**
            Applicable only for item prices with:

            * [item_type](/docs/api/item_prices/item_price-object#item_type) = `addon`.
            * [pricing_model](/docs/api/item_prices/item_price-object#pricing_model) = `per_unit`.

            Specifies how to manage charges or credits for the addon item price during a [subscription update](/docs/api/subscriptions/update-subscription-for-items)
            or [estimating](/docs/api/estimates/estimate-for-updating-a-subscription)
            a subscription update.

            * site_default -
              Use the [site-wide proration setting](https://www.chargebee.com/docs/2.0/proration.html#proration-for-subscription-change)
              .
            * partial_term - Prorate the charges or credits for the rest of the current term.
            * full_term - Charge the full price of the addon item price or give the full credit. Don't apply any proration.
          enum:
          - site_default
          - partial_term
          - full_term
          example: null
        pricing_model:
          type: string
          default: flat_fee
          deprecated: false
          description: |
            The [pricing scheme](https://www.chargebee.com/docs/2.0/plans.html#pricing-models) for this item price. If subscriptions, invoices or [differential prices](/docs/api/differential_prices) exist for this item price, `pricing_model` cannot be changed.

            * 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
        price:
          type: integer
          format: int64
          deprecated: false
          description: |
            The cost of the item price when the pricing model is `flat_fee`.
            When the pricing model is `per_unit`
            , it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in the [minor unit of the currency](/docs/api/currencies)
            .
          minimum: 0
          example: null
        price_in_decimal:
          type: string
          deprecated: false
          description: |
            The price of the item when the pricing_model is `flat_fee`.
            When the pricing model is `per_unit`
            , 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 [multi-decimal pricing](/docs/api/currencies)
            is enabled.
          maxLength: 39
          example: null
        period:
          type: integer
          format: int32
          deprecated: false
          description: |
            * When the item `type` is `plan`: The billing period of the plan in `period_unit`s. For example, create a 6 month plan by providing `period` as 6 and `period_unit` as month.
            * When item `type` is `addon`: The period of the addon in `period_unit`s. For example, create an addon with a 2 month `period` by providing period as 2 and `period_unit` as `month`. The period of an addon is the duration for which its `price` applies. When attached to a plan, the addon is billed for the billing period of the plan. [Learn more.](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)

            If subscriptions or invoices exist for this item price, `period`
            cannot be changed. The `period`
            is mandatory when the item `type`
            is `plan`
            or `addon`
          minimum: 1
          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)
            ) for the item price. If subscriptions, invoices or [differential prices](/docs/api/differential_prices)
            exist for this item price, `currency_code`
            cannot be changed.
          maxLength: 3
          example: null
        period_unit:
          type: string
          deprecated: false
          description: |
            The unit of time for `period`.
            If subscriptions or invoices exist for this item price, `period_unit`
            cannot be changed. The `period_unit`
            is mandatory when the item `type`
            is `plan`
            or `addon`

            * month - A period of 1 calendar month.
            * day - A period of 24 hours.
            * week - A period of 7 days.
            * year - A period of 1 calendar year.
          enum:
          - day
          - week
          - month
          - year
          example: null
        trial_period:
          type: integer
          format: int32
          deprecated: false
          description: |
            The trial period of the plan in `trial_period_unit`
            s. You can also set [trial periods for addons](https://www.chargebee.com/docs/2.0/addons-trial.html)
            ; 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 enable that feature.
          minimum: 0
          example: null
        trial_period_unit:
          type: string
          deprecated: false
          description: |
            The unit of time for `trial_period`
            .

            * month - A period of 1 calendar month.
            * day - A period of 24 hours.
          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/2.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
            has been enabled for the site. Specifies the operation to be carried out for the subscription once the trial ends. Whenever the `item.type`
            is `plan`
            and a trial period is defined for this item price, this attribute (parameter) is returned (required). This can be overridden at the [subscription-level](/docs/api/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/2.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
        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: "The default number of billing cycles a subscription to the\
            \ plan must run. Can be [overridden](/docs/api/subscriptions) for a subscription.\n\
            Addons can also [have billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html).\
            \ Also, for addons, you can [override this](/docs/api/attached_items)\
            \ while attaching it to a plan. However, if you provide the value while\
            \ [applying the addon to a subscription](/docs/api/subscriptions/subscription-object#subscription_items_item_type),\
            \ then that value takes still higher precedence.\nIf subscriptions, invoices\
            \ or [differential prices](/docs/api/differential_prices)\nexist for this\
            \ item price, `billing_cycles`\ncannot be changed.  \n**Note:**\nIf you\
            \ want to change the `billing_cycles`\nto unlimited renewals, enter an\
            \ empty string. This value can only be updated if the `item_price`\nis\
            \ not attached to a subscription or invoice. If no `billing_cycles`\n\
            value is entered, then by default the value will be set as unlimited `billing_cycles`\n\
            renewals.\n"
          minimum: 1
          example: null
        free_quantity:
          type: integer
          format: int32
          default: 0
          deprecated: false
          description: "Free quantity the subscriptions of this **plan** `item_price`\
            \ will have. Only the quantity exceeding this value will be charged in\
            \ the subscription.  \n**Note:**\n\n* `free_quantity` is currently supported\
            \ only for [plan](/docs/api/items/item-object#type) `item_price`.\n* `free_quantity`\
            \ is not supported for the [Usage-Based Billing](https://www.chargebee.com/docs/2.0/understanding-usages.html)\
            \ (UBB). All included or free quantities should be configured exclusively\
            \ through [entitlements](/docs/api/entitlements) .\n"
          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/currencies)
            is enabled.
          maxLength: 33
          example: null
        channel:
          type: string
          deprecated: false
          description: "The subscription channel this object originated from and is\
            \ maintained in.\n\n* web - The object was created (and is maintained)\
            \ for the web channel directly in Chargebee via API or UI.\n* app_store\
            \ -\n  The 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  The 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.  \n  In-App Subscriptions is currently in early\
            \ access. Contact [eap@chargebee.com](mailto:eap@chargebee.com)\n  for\
            \ more information.\n"
          enum:
          - web
          - app_store
          - play_store
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            Version number of this resource. The `resource_version`
            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.
          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: "Specifies the frequency at which the usage counter needs to\
            \ be reset.  \n**Note:**\nChanges to the `usage_accumulation_reset_frequency`\n\
            parameter for `item_price`\nis not allowed if the `item`\nis already linked\
            \ to a subscription.\n\n* never - Accumulates usage without ever resetting\
            \ it.\n* subscription_billing_frequency - Accumulates usage until the\
            \ subscription's billing frequency ends.\n"
          enum:
          - never
          - subscription_billing_frequency
          example: null
        archived_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this item price was archived.
          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
        is_taxable:
          type: boolean
          default: true
          deprecated: false
          description: |
            Specifies whether taxes apply to this item price. 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
        metadata:
          type: object
          additionalProperties: true
          deprecated: false
          description: |
            A collection of key-value pairs that provides extra information about the item price. [Learn more](/docs/api/advanced-features#metadata)
            .
          example: null
        item_type:
          type: string
          deprecated: false
          description: |
            Type of item.

            * 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.
            * 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.
            * addon - A recurring component that can be added to a subscription in addition to its plan.
          enum:
          - plan
          - addon
          - charge
          example: null
        show_description_in_invoices:
          type: boolean
          deprecated: false
          description: |
            Whether the item price's description 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
          deprecated: false
          description: |
            Whether the item price's description 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
        deleted:
          type: boolean
          deprecated: false
          description: |
            Indicates whether the item price has been deleted ot not.
          example: null
        business_entity_id:
          type: string
          deprecated: false
          description: |
            The unique ID of the
            [business entity](/docs/api/business_entities)
            of this `item_family`.
            This is applicable only when multiple business entities have been created for the site. The value of this attribute indicates that the resource is specific to the given business entity.
          maxLength: 50
          example: null
        tiers:
          type: array
          deprecated: false
          description: |
            List of quantity-based pricing tiers for the item price. Applicable only for `tiered`
            , `volume`
            , and `stairstep`
            `pricing_models`
            .
          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: |
                  The per-unit price for the tier when the `pricing_model`
                  is `tiered`
                  or `volume`
                  ; the total cost for the item price when the `pricing_model`
                  is `stairstep`.
                  The value is in the [minor unit of the currency](/docs/api/currencies)
                  .
                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
              pricing_type:
                type: string
                deprecated: false
                description: |
                  Pricing type for the tier.

                  * flat_fee -
                    Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                    pricing model, `pricing_type`
                    will be set to `flat_fee`
                    by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                  * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                  * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20, consuming 400 units will result in a charge of $80 (4 × $20).
                enum:
                - per_unit
                - flat_fee
                - package
                example: null
              package_size:
                type: integer
                format: int32
                deprecated: false
                description: |
                  Package size for the tier when pricing type is `package`.
                  Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                minimum: 1
                example: null
            required:
            - price
            - starting_unit
            example: null
          example: null
        tax_detail:
          type: object
          deprecated: false
          description: |
            The tax details for the item price. Includes those details relevant for third-party integrations.
          properties:
            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)
                .

                * consumed - Transaction is for an item that is consumed directly
                * 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
              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
          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 supported.
                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
        accounting_detail:
          type: object
          deprecated: false
          description: |
            Accounting integration details. The values are typically dependent on the [accounting integration](https://www.chargebee.com/docs/finance-integration-index.html)
            used.
          properties:
            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: |
                Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/2.0/finance-integration-index.html )

                * [**Xero:**](https://www.chargebee.com/docs/2.0/xero.html ) If you've categorized your products in Xero, provide the category name and option. Use the format: `:` . For example:`Location: Singapore.`
                * [**QuickBooks:**](https://www.chargebee.com/docs/2.0/quickbooks.html ) If you've categorized your product sales in QuickBooks according to Classes, provide the class name here. Use the following format: `::...`
                * [**NetSuite:**](https://www.chargebee.com/docs/2.0/netsuite.html ) If you've categorized your products in NetSuite under Classes, provide the class name here. Use the following format: `: : ....` For example: `Services: Plan.`
                * [**Intacct:**](https://www.chargebee.com/docs/2.0/intacct.html ) If you've classified your products in Intacct under Locations, provide the name of the Location here.
              maxLength: 100
              example: null
            accounting_category2:
              type: string
              deprecated: false
              description: |
                Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/2.0/finance-integration-index.html )

                * [**Xero:**](https://www.chargebee.com/docs/2.0/xero.html ) If you've categorized your products in Xero, then provide the second category name and option here. Use the format: `: ....` For example, `Region: South`
                * [**QuickBooks:**](https://www.chargebee.com/docs/2.0/quickbooks.html ) If you've categorized your product sales in QuickBooks according to Location, provide the Location name here. Use the following format: `::....` For example: `Location: North America: Canada`
                * [**NetSuite:**](https://www.chargebee.com/docs/2.0/netsuite.html ) If you've categorized your products in NetSuite under Locations, provide the location name here. Use the following format `: : ....` For example: `NA:US:CA`
                * [**Intacct:**](https://www.chargebee.com/docs/2.0/intacct.html ) If you've classified your products in Intacct under Dimensions, provide the value of the Dimension here.
              maxLength: 100
              example: null
            accounting_category3:
              type: string
              deprecated: false
              description: |
                Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/2.0/finance-integration-index.html )

                * [**NetSuite:**](https://www.chargebee.com/docs/2.0/netsuite.html ) If you've categorized your products in NetSuite under Departments, pass the department name here. Use the following format: `: : ....` For example: `Production: Assembly.`
                * [**Intacct:**](https://www.chargebee.com/docs/2.0/intacct.html ) If you've classified your products in Intacct under multiple Dimensions, provide the value of the second Dimension here.
              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
          example: null
      required:
      - created_at
      - currency_code
      - deleted
      - free_quantity
      - id
      - name
      - pricing_model
      example: null
    ItemPriceCreatedEvent:
      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:
            item_price:
              $ref: "#/components/schemas/ItemPrice"
          required:
          - item_price
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    ItemPriceDeletedEvent:
      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:
            item_price:
              $ref: "#/components/schemas/ItemPrice"
          required:
          - item_price
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    ItemPriceEntitlementsRemovedEvent:
      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:
            feature:
              $ref: "#/components/schemas/Feature"
            metadata:
              $ref: "#/components/schemas/Metadata"
            impacted_item_price:
              $ref: "#/components/schemas/ImpactedItemPrice"
            impacted_subscription:
              $ref: "#/components/schemas/ImpactedSubscription"
          required:
          - feature
          - impacted_item_price
          - impacted_subscription
          - metadata
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    ItemPriceEntitlementsUpdatedEvent:
      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:
            feature:
              $ref: "#/components/schemas/Feature"
            metadata:
              $ref: "#/components/schemas/Metadata"
            impacted_item_price:
              $ref: "#/components/schemas/ImpactedItemPrice"
            impacted_subscription:
              $ref: "#/components/schemas/ImpactedSubscription"
          required:
          - feature
          - impacted_item_price
          - impacted_subscription
          - metadata
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    ItemPriceUpdatedEvent:
      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:
            item_price:
              $ref: "#/components/schemas/ItemPrice"
          required:
          - item_price
          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
    ItemUpdatedEvent:
      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:
            item:
              $ref: "#/components/schemas/Item"
          required:
          - item
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    Layout:
      type: string
      deprecated: false
      enum:
      - in_app
      - full_page
      example: null
    LedgerAccountBalance:
      type: object
      description: "Credit Grants\n-------------\n\nA credit grant is a quantified\
        \ allocation of credits given to a subscription through a configured [item\
        \ price](/docs/api/item_prices) or via the [allocate](/docs/api/ledger_operations/allocate)\
        \ operation, consumed over time through ledger operations.  \n**Example**\n\
        \nA subscription receives a credit grant of 100 AI credits as a balance. As\
        \ the customer uses AI features\n(e.g., Image Generation), the provisioned\
        \ balance is consumed first. Once exhausted, further consumption is deducted\
        \ from the overdraft balance until its limit is reached.\n\nThe Ledger Account\
        \ Balance object\n---------------------------------\n\nThe `ledger_account_balance`\
        \ object is a real-time snapshot of credit grants for a single combination\
        \ of subscription_id, unit_id and unit_type.\n\nThe ledger tracks two balances:\n\
        \n* [**provisioned_balance**](#provisioned_balance): Reflects the credit grants\
        \ given through the configured item price or allocate operations. These are\
        \ prepaid credit grants for which the customer has already paid. Any ledger\
        \ operation will prioritize consuming this balance first.\n* [**overdraft_balance**](#overdraft_balance):\
        \ Reflects the extra limit provided to a subscription in case it exhausts\
        \ all credit grants before they are renewed or refreshed. Any ledger operation\
        \ will consume this balance only when the provisioned balance has been exhausted.\n\
        \n**Note**\n\nThese two balances are always tracked together for a subscription\
        \ with credit grants.  \n**Example**\n\nA subscription has a credit grant\
        \ of 100 AI credits, added to its provisioned balance. Once the provisioned\
        \ balance is exhausted, further consumption is drawn from the overdraft balance\
        \ up to its configured limit.\nscreenshot\\|/images/account_balance.png\n\n\
        **Returned by**\n\n* [List ledger account balances](/docs/api/ledger_account_balances/list-ledger-account-balances)\
        \ API.\n* Ledger [operations](/docs/api/ledger_operations) such as [allocate](/docs/api/ledger_operations/allocate),\
        \ [capture](/docs/api/ledger_operations/capture), and [authorize](/docs/api/ledger_operations/authorize).\n"
      properties:
        subscription_id:
          type: string
          deprecated: false
          description: |
            A unique, immutable identifier for the [subscription](/docs/api/subscriptions/subscription-object#id) this account belongs to.
          maxLength: 50
          example: null
        unit_id:
          type: string
          deprecated: false
          description: |
            Identifier of the credit unit this account tracks. For example, a credit unit id such as `ai_credits`.
          maxLength: 50
          example: null
        unit_type:
          type: string
          deprecated: false
          description: |
            Type of unit used for this balance.

            * credit_unit - The unit represents a credit unit, the type used by credit grants.
          enum:
          - credit_unit
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Unix timestamp (in seconds) indicating when this ledger account balance was first recorded.
          example: null
        modified_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Unix timestamp (seconds) when the balance was last updated. For example, after [allocate](/docs/api/ledger_operations/allocate), [capture](/docs/api/ledger_operations/capture), or [authorize](/docs/api/ledger_operations/authorize).
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            Version number of this resource. The `resource_version` is updated with a new timestamp for every change made to the resource.
          example: null
        provisioned_balance:
          type: object
          deprecated: false
          description: |
            Stores credit grants given through the configured item price. Used first before overdraft.
          properties:
            total_balance:
              type: string
              deprecated: false
              description: "Total granted credits remaining, including held amounts.\n\
                Returned as a decimal string.  \n**Constraints**\n\nMaximum supported\
                \ value: `9999999999999999999999999.9999999999` (up to 25 digits before\
                \ the decimal and up to 10 digits after).\n\n`total_balance = usable_balance\
                \ + hold_amount`\n\n**Example:** If a subscription has a credit grant\
                \ of `100` AI credits and `30` have been consumed, total_balance is\
                \ `70`.\n"
              maxLength: 36
              example: null
            usable_balance:
              type: string
              deprecated: false
              description: "Credits available for immediate use (excludes held amount).\n\
                Returned as a decimal string.  \n**Constraints**\n\nMaximum supported\
                \ value: `9999999999999999999999999.9999999999` (up to 25 digits before\
                \ the decimal and up to 10 digits after).\n\n**Example:** If total_balance\
                \ is `70` and hold_amount is `5`, usable_balance is `65`.\n"
              maxLength: 36
              example: null
            hold_amount:
              type: string
              deprecated: false
              description: "Credits reserved for in-progress operations (e.g., authorize);\
                \ not currently usable.\nReturned as a decimal string.  \n**Constraints**\n\
                \nMaximum supported value: `9999999999999999999999999.9999999999`\
                \ (up to 25 digits before the decimal and up to 10 digits after).\n\
                \n**Example:** If `10` AI credits are reserved for a pending operation,\
                \ hold_amount is `10` and usable_balance is reduced accordingly.\n"
              maxLength: 36
              example: null
          required:
          - hold_amount
          - total_balance
          - usable_balance
          example: null
        overdraft_balance:
          type: object
          deprecated: false
          description: |
            Extra credit available after provisioned balance is exhausted.
          properties:
            is_unlimited:
              type: boolean
              default: false
              deprecated: false
              description: |
                Whether overdraft has no limit (`true`) or is capped (`false`). When `true`, the `limit`, `total_balance`, `usable_balance`, and `hold_amount` fields are `null`.
              example: null
            limit:
              type: string
              deprecated: false
              description: "Maximum overdraft allowed. Present only when [`overdraft_balance.is_unlimited`](#overdraft_balance_is_unlimited)\
                \ is `false`.\nReturned as a decimal string.  \n**Constraints**\n\n\
                Maximum supported value: `9999999999999999999999999.9999999999` (up\
                \ to 25 digits before the decimal and up to 10 digits after).\n"
              maxLength: 36
              example: null
            total_balance:
              type: string
              deprecated: false
              description: "Total granted credits remaining, including held amounts.\n\
                Returned as a decimal string.  \n**Constraints**\n\nMaximum supported\
                \ value: `9999999999999999999999999.9999999999` (up to 25 digits before\
                \ the decimal and up to 10 digits after).\n\n**Example:** If limit\
                \ is `25` and used_amount is `10`, the remaining overdraft capacity\
                \ is `15`.\n"
              maxLength: 36
              example: null
            usable_balance:
              type: string
              deprecated: false
              description: "Remaining overdraft available for use.\nReturned as a\
                \ decimal string.  \n**Constraints**\n\nMaximum supported value: `9999999999999999999999999.9999999999`\
                \ (up to 25 digits before the decimal and up to 10 digits after).\n\
                \nUsable Balance (Only if Capped): `limit - used_amount - hold_amount`.\n"
              maxLength: 36
              example: null
            used_amount:
              type: string
              deprecated: false
              description: "Credits already consumed from overdraft.\nReturned as\
                \ a decimal string.  \n**Constraints**\n\nMaximum supported value:\
                \ `9999999999999999999999999.9999999999` (up to 25 digits before the\
                \ decimal and up to 10 digits after).\n"
              maxLength: 36
              example: null
            hold_amount:
              type: string
              deprecated: false
              description: "Overdraft credits reserved for in-progress operations.\n\
                Returned as a decimal string.  \n**Constraints**\n\nMaximum supported\
                \ value: `9999999999999999999999999.9999999999` (up to 25 digits before\
                \ the decimal and up to 10 digits after).\n"
              maxLength: 36
              example: null
          required:
          - hold_amount
          - is_unlimited
          - used_amount
          example: null
      required:
      - created_at
      - modified_at
      - subscription_id
      - unit_id
      - unit_type
      example: null
    LedgerAccountBalanceUpdatedEvent:
      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:
            ledger_account_balance:
              $ref: "#/components/schemas/LedgerAccountBalance"
          required:
          - ledger_account_balance
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    LedgerEntry:
      type: object
      description: "A ledger entry is the lowest-level, immutable record of a single\
        \ movement of credit grants against one [grant block](/docs/api/grant_blocks).\
        \ While a [ledger operation](/docs/api/ledger_operations) represents the business\
        \ action (for example, a `capture` or `authorize`), each operation is expanded\
        \ internally into one or more ledger entries that describe exactly how individual\
        \ grant blocks were affected.  \n**Behavior**\n\n* Ledger entries are immutable\
        \ once recorded.\n* A single ledger operation can generate multiple entries.\
        \ When a capture (or other consumption) spans several grant blocks, a ledger\
        \ entry is created corresponding to each grant block, reflecting the amount\
        \ captured from that grant block.\n* The [`type`](#type) field conveys the\
        \ direction of each movement; [`amount`](#amount) is always positive.  \n\
        **Usage**\n\nLedger entries provide the granular, per-grant-block audit trail.\n"
      properties:
        id:
          type: string
          deprecated: false
          description: "A unique identifier for this ledger entry.  \n**Behavior**\n\
            \n* Automatically assigned by the ledger at creation time.\n* Immutable\
            \ and cannot be modified once written.\n"
          maxLength: 50
          example: null
        subscription_id:
          type: string
          deprecated: false
          description: |
            A unique, immutable identifier for the [subscription](/docs/api/subscriptions/subscription-object#id) against which this ledger entry was recorded. Always returned.
          maxLength: 50
          example: null
        unit_id:
          type: string
          deprecated: false
          description: |
            Identifier of the credit unit this entry affects. For example, a credit unit id such as `ai_credits`. Always returned.
          maxLength: 50
          example: null
        unit_type:
          type: string
          deprecated: false
          description: |
            Type of unit used for this entry. Always returned.

            * credit_unit - The unit represents a credit unit, the type used by credit grants.
          enum:
          - credit_unit
          example: null
        account_type:
          type: string
          deprecated: false
          description: |
            The account this entry belongs to: **provisioned** (credit grants issued per the plan, consumed first) or
            **overdraft** (consumption beyond the configured credit grants, after the provisioned account is exhausted). Always returned.

            * overdraft -
              Allows consumption beyond the configured credit grants. Used once the credit grants in the provisioned account
              are exhausted.
            * provisioned -
              Stores the credit grants given as per the plan configuration. Consumption of credit grants is first done
              through this account.
          enum:
          - provisioned
          - overdraft
          example: null
        amount:
          type: string
          deprecated: false
          description: "The number of credit grants moved by this entry against a\
            \ single grant block.\nReturned as a decimal string.  \n**Constraints**\n\
            \nMaximum supported value: `9999999999999999999999999.9999999999` (up\
            \ to 25 digits before the decimal and up to 10 digits after).  \n**Behavior**\n\
            \n* Always a positive value; the direction of the movement is conveyed\
            \ by [`type`](#type).\n"
          maxLength: 36
          example: null
        grant_block_start_balance:
          type: string
          deprecated: false
          description: "The grant block balance immediately before this ledger entry\
            \ was applied.\nReturned as a decimal string.  \n**Constraints**\n\nMaximum\
            \ supported value: `9999999999999999999999999.9999999999` (up to 25 digits\
            \ before the decimal and up to 10 digits after).\n"
          maxLength: 36
          example: null
        grant_block_end_balance:
          type: string
          deprecated: false
          description: "The grant block balance immediately after this ledger entry\
            \ was applied.\nReturned as a decimal string.  \n**Constraints**\n\nMaximum\
            \ supported value: `9999999999999999999999999.9999999999` (up to 25 digits\
            \ before the decimal and up to 10 digits after).\n"
          maxLength: 36
          example: null
        account_start_balance:
          type: string
          deprecated: false
          description: "The account balance (provisioned or overdraft, matching [`account_type`](#account_type))\
            \ immediately before this ledger entry was applied.\nReturned as a decimal\
            \ string.  \n**Constraints**\n\nMaximum supported value: `9999999999999999999999999.9999999999`\
            \ (up to 25 digits before the decimal and up to 10 digits after).\n"
          maxLength: 36
          example: null
        account_end_balance:
          type: string
          deprecated: false
          description: "The account balance (provisioned or overdraft, matching [`account_type`](#account_type))\
            \ immediately after this ledger entry was applied.\nReturned as a decimal\
            \ string.  \n**Constraints**\n\nMaximum supported value: `9999999999999999999999999.9999999999`\
            \ (up to 25 digits before the decimal and up to 10 digits after).\n"
          maxLength: 36
          example: null
        type:
          type: string
          deprecated: false
          description: |
            Specifies the direction of the movement of credit grants recorded by this entry.

            * debit - Credit grants consumed from a grant block.
            * credit - Credit grants added when a grant block is allocated.
            * unhold -
              Credit grants released allowing the amount to go from hold amount back to the usable amount via
              release_authorization or the auto-release job.
            * hold - Credit grants reserved on a grant block by an authorize operation, moved from usable balance to hold amount.
          enum:
          - credit
          - debit
          - hold
          - unhold
          example: null
        ledger_operation_id:
          type: string
          deprecated: false
          description: |
            Identifier of the [ledger operation](/docs/api/ledger_operations) that produced this entry. Multiple
            entries can share the same `ledger_operation_id` when a single operation spans more than one grant block
            or produces more than one movement.
          maxLength: 50
          example: null
        grant_block_id:
          type: string
          deprecated: false
          description: |
            Identifier of the [grant block](/docs/api/grant_blocks) this entry acts upon.
          maxLength: 50
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: "Unix timestamp (in seconds) indicating when this ledger entry\
            \ was recorded in the ledger.  \n**Behavior**\n\n* Automatically set by\
            \ the ledger at creation time.\n* Immutable and cannot be modified once\
            \ written.\n"
          example: null
        modified_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Unix timestamp (in seconds) indicating when this ledger entry record was last updated in the ledger.
          example: null
      required:
      - account_end_balance
      - account_start_balance
      - account_type
      - amount
      - created_at
      - grant_block_end_balance
      - grant_block_id
      - grant_block_start_balance
      - id
      - ledger_operation_id
      - modified_at
      - subscription_id
      - type
      - unit_id
      - unit_type
      example: null
    LedgerOperation:
      type: object
      description: "A ledger operation represents a single action recorded in the\
        \ ledger that results in a state change. Each ledger operation corresponds\
        \ to one atomic event, whether initiated externally or internally.  \n**Behavior**\n\
        \n* Ledger Operations are immutable once recorded.\n* They provide traceability,\
        \ idempotency, and a complete audit trail of all state transitions.  \n**Usage**\n\
        \nServes as the fundamental unit for representing, tracking, and reconciling\
        \ all changes within the system.\n"
      properties:
        id:
          type: string
          deprecated: false
          description: "A unique identifier for this ledger operation.  \n**Behavior**\n\
            \n* In case of external ledger operations, the id can be optionally provided\
            \ by the upstream system.\n* In case of internal ledger operations, the\
            \ id is generated by the ledger.\n* Immutable and cannot be modified once\
            \ written.\n"
          maxLength: 50
          example: null
        subscription_id:
          type: string
          deprecated: false
          description: |
            A unique, immutable identifier for the [subscription](/docs/api/subscriptions/subscription-object#id) against which this ledger operation was recorded. Always returned.
          maxLength: 50
          example: null
        unit_id:
          type: string
          deprecated: false
          description: |
            Identifier of the credit unit this ledger operation affects. For example, a credit unit id such as `ai_credits`. Always returned.
          maxLength: 100
          example: null
        unit_type:
          type: string
          deprecated: false
          description: |
            Type of unit used for this ledger operation. Always returned.

            * credit_unit - The unit represents a credit unit, the type used by credit grants.
          enum:
          - credit_unit
          example: null
        type:
          type: string
          deprecated: false
          description: "Specifies the type of ledger operation, indicating the kind\
            \ of business event this record represents.  \n**Types**\n\n**External\
            \ Ledger Operations**: Triggered via API calls\n\n* `allocation` (via\
            \ the allocate API)\n* `authorize`\n* `capture`\n* `capture_authorization`\n\
            * `release_authorization`\n\n**Internal Ledger Operations**: Triggered\
            \ via system processes\n\n* `allocation` (plan-driven / configured credit\
            \ grants)\n* `expiry`\n* `rollover`\n* `void`\n* `adjustment`\n* `overdraft_settlement`\n\
            \n* authorize - Reserves credit grants (moves from `usable_balance` to\
            \ `hold_amount`) for later capture or release.\n* release_authorization\
            \ - Returns a hold to the usable balance, or finalizes an auto-release\
            \ of the hold.\n* allocation - Credit grants allocated into an account,\
            \ such as allocations created from configured credit grants or the allocate\
            \ operation.\n* overdraft_settlement - Finalizes overdraft usage once\
            \ it has been invoiced, marking the used credits as billed.\n* void -\
            \ Credit grants removed from a grant block through administrative updates.\n\
            * rollover - Carry-forward of balance into a new grant block or related\
            \ rollover run.\n* capture - Immediate one-step debit of credit grants\
            \ from the usable balance.\n* expiry - Credit grants expired from a grant\
            \ block (and related account movements).\n* capture_authorization -\n\
            \  Finalizes a hold, converting all or part of the held amount into a\
            \ final debit; any remainder can be\n  auto-released.\n* adjustment -\
            \ When overdraft is in adjustment mode, new credit grants can adjust an\
            \ existing overdraft balance.\n"
          enum:
          - allocation
          - capture
          - authorize
          - release_authorization
          - capture_authorization
          - expiry
          - void
          - rollover
          - adjustment
          - overdraft_settlement
          example: null
        amount:
          type: string
          deprecated: false
          description: "Represents the quantity of credit grants affected by this\
            \ ledger operation.\nReturned as a decimal string.  \n**Constraints**\n\
            \nMaximum supported value: `9999999999999999999999999.9999999999` (up\
            \ to 25 digits before the decimal and up to 10 digits after).  \n**Behavior\
            \ by Ledger Operation Type**\n\n* `capture`: Credit grants debited from\
            \ the account immediately.\n* `authorize`: Credit grants reserved, moving\
            \ from usable balance to hold amount.\n* `capture_authorization`: Credit\
            \ grants finalized as consumption (converted from hold amount to debited);\
            \ any remaining hold amount is automatically released.\n* `release_authorization`:\
            \ Credit grants released from hold amount back to the usable balance.\n\
            * `expiry`: Credit grants that have lapsed after the validity and grace\
            \ period.\n* `rollover`: Credit grants carried forward into a new grant\
            \ block.\n* `void`: Credit grants removed through administrative updates.\n"
          maxLength: 36
          example: null
        provisioned_start_balance:
          type: string
          deprecated: false
          description: "The provisioned account balance immediately before this ledger\
            \ operation was applied.\nReturned as a decimal string.  \n**Constraints**\n\
            \nMaximum supported value: `9999999999999999999999999.9999999999` (up\
            \ to 25 digits before the decimal and up to 10 digits after).  \n**Usage**\n\
            \nUse alongside `provisioned_end_balance` to trace exactly how each ledger\
            \ operation moved the provisioned account balance over time.\n"
          maxLength: 36
          example: null
        provisioned_end_balance:
          type: string
          deprecated: false
          description: "The provisioned account balance immediately after this ledger\
            \ operation was applied.\nReturned as a decimal string.  \n**Constraints**\n\
            \nMaximum supported value: `9999999999999999999999999.9999999999` (up\
            \ to 25 digits before the decimal and up to 10 digits after).  \n**Usage**\n\
            \nUse alongside `provisioned_start_balance` to trace exactly how each\
            \ ledger operation moved the provisioned account balance over time.\n"
          maxLength: 36
          example: null
        overdraft_start_balance:
          type: string
          deprecated: false
          description: "The overdraft account balance immediately before this ledger\
            \ operation was applied.\nReturned as a decimal string.  \n**Constraints**\n\
            \nMaximum supported value: `9999999999999999999999999.9999999999` (up\
            \ to 25 digits before the decimal and up to 10 digits after).  \n**Usage**\n\
            \nUse alongside `overdraft_end_balance` to trace exactly how each ledger\
            \ operation moved the overdraft account balance over time.\n"
          maxLength: 36
          example: null
        overdraft_end_balance:
          type: string
          deprecated: false
          description: "The overdraft account balance immediately after this ledger\
            \ operation was applied.\nReturned as a decimal string.  \n**Constraints**\n\
            \nMaximum supported value: `9999999999999999999999999.9999999999` (up\
            \ to 25 digits before the decimal and up to 10 digits after).  \n**Usage**\n\
            \nUse alongside `overdraft_start_balance` to trace exactly how each ledger\
            \ operation moved the overdraft account balance over time.\n"
          maxLength: 36
          example: null
        parent_ledger_operation_id:
          type: string
          deprecated: false
          description: "The `ledger_operation_id` of the parent `authorize` ledger\
            \ operation associated with this ledger operation.  \n**Usage**\n\n* Present\
            \ on `capture_authorization` and `release_authorization` ledger operations\
            \ to identify the hold being finalized or released.\n* Also present on\
            \ internally generated release ledger operations (for example, partial-capture\
            \ remainders) to correlate them back to the original authorization.  \n\
            **Constraints**\n\n* Must match the `ledger_operation_id` used in the\
            \ original `authorize` call.\n* The same value should be reused across\
            \ retries.\n"
          maxLength: 50
          example: null
        ledger_operation_timestamp:
          type: integer
          format: unix-time
          deprecated: false
          description: "Unix timestamp (in seconds) representing when the business\
            \ event occurred in the upstream system. Used for period attribution,\
            \ grace-period eligibility, and reporting accuracy.  \n**Note**\n\nLate\
            \ or out-of-order submissions appear in arrival order, while attribution\
            \ and eligibility logic rely on `ledger_operation_timestamp`.  \n**Constraints**\n\
            \n* The `ledger_operation_timestamp` must be within the last 10 minutes\
            \ from the time of the request.\n* Grant blocks outside their active window\
            \ (including those in the grace period) are not eligible for authorization\
            \ and are excluded from balance checks for this ledger operation.\n"
          example: null
        auto_release_timestamp:
          type: integer
          format: unix-time
          deprecated: false
          description: "Unix timestamp (in seconds) indicating when an unfinalized\
            \ hold amount from an authorize request will be automatically released\
            \ back to the usable balance.  \n**Behavior**\n\n* Applies only to authorize\
            \ ledger operations.\n* If not explicitly provided, the system assigns\
            \ a default expiry.\n* Defaults to approximately 10 minutes after the\
            \ authorize request is processed.  \n**Usage**\n\nEnsures held credit\
            \ grants are not locked indefinitely by abandoned or unfinalized authorizations.\
            \  \n**Note**\n\n* By default, the value reflects what is provided in\
            \ the request.\n* If the specified timestamp exceeds the end of the block's\
            \ grace period, it is adjusted (clamped) to the grace period end and returned\
            \ in the response.\n"
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: "Unix timestamp (in seconds) indicating when this ledger operation\
            \ was recorded in the system.  \n**Behavior**\n\n* Automatically set by\
            \ the system at the time of persistence.\n* Immutable and cannot be modified\
            \ once written.  \n**Note**\n\nServes as the source of truth for ordering\
            \ ledger operations and tracking how they affected the balance over time.\n"
          example: null
        modified_at:
          type: integer
          format: unix-time
          deprecated: false
          description: "Unix timestamp (in seconds) indicating when this ledger operation\
            \ record was last updated in the system.  \n**Behavior**\n\nAutomatically\
            \ updated by the system whenever the record is modified.\n"
          example: null
        metadata:
          type: object
          additionalProperties: true
          deprecated: false
          description: "Optional opaque JSON object carrying additional business context\
            \  \n**Behavior**\n\n* Stored as-is and returned verbatim by the system.\n\
            * Not interpreted, validated, or indexed by the system.\n"
          example: null
      required:
      - amount
      - created_at
      - id
      - ledger_operation_timestamp
      - modified_at
      - overdraft_end_balance
      - overdraft_start_balance
      - provisioned_end_balance
      - provisioned_start_balance
      - subscription_id
      - type
      - unit_id
      - unit_type
      example: null
    LedgerUpdatedEvent:
      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:
            ledger_operations:
              type: array
              items:
                $ref: "#/components/schemas/LedgerOperation"
              example: null
            ledger_account_balance:
              $ref: "#/components/schemas/LedgerAccountBalance"
            grant_blocks:
              type: array
              items:
                $ref: "#/components/schemas/GrantBlock"
              example: null
            ledger_entries:
              type: array
              items:
                $ref: "#/components/schemas/LedgerEntry"
              example: null
          required:
          - grant_blocks
          - ledger_account_balance
          - ledger_entries
          - ledger_operations
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    Level:
      type: object
      description: |
        This resource returns the entitlement level attributes.
      properties:
        name:
          type: string
          deprecated: false
          description: |
            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 `Email Support`
            can have entitlement levels named as `All weekdays`
            , `All days`
            , `40 hours per week`
            and so on.

            When not provided for `feature.type`
            `quantity`
            or `range`
            , this name is auto-generated as the space-separated concatenation of `levels[].value`
            and the pluralized version of `unit`.
            For example, if `levels[].value`
            is `20`
            and `unit`
            is `user`
            , then `levels[].name`
            becomes `20 users`
            .
          maxLength: 100
          example: null
        value:
          type: string
          deprecated: false
          description: |
            The value denoting the entitlement level granted.

            * **When `type` is `quantity`:** this attribute denotes the quantity of units of the feature for this entitlement level. For example, a feature such as `number of users` can have `levels[].value` as `5`, `20`, `50`, and `100`. `levels[].is_unlimited` is used to set the entitlement level to "unlimited".
            * **When `type` is `range`:** there can be be only two elements in the `levels[]` array; one corresponding to the minimum value (`levels[0]`) and the other to the maximum value (`levels[1]`) of the range of possible entitlement levels. For example, a feature such as `number of users` may have `levels[0].value` = `5` and `levels[1].value` = `50000`. When the upper limit is "unlimited", then `levels[1].value` is not set and `levels[1].is_unlimited` is `true`.
            * **When `type` is `custom`:** this attribute denotes the value of this custom entitlement level. For example, a feature `Email Support` can have `levels[].value` as one of say, `24×7` and `24×5`.
          maxLength: 50
          example: null
        level:
          type: integer
          format: int32
          deprecated: false
          description: |
            This attribute represents the order of the entitlement levels from lowest to highest.

            * When `type` is `quantity` or `custom`: The lowest entitlement level has the value `0`, the next higher level has the value `1`, followed by `2`, and so on.
            * When `type` is `range`: This attribute is `0` for the minimum value and `1` for the maximum value in the range.

            When not defined, it is assumed as the index of the `levels[]`
            array.
          example: null
        is_unlimited:
          type: boolean
          deprecated: false
          description: |
            When `type`
            is `quantity`
            or `range`
            , this attribute indicates whether the entitlement level corresponds to unlimited units of the feature. Possible values:

            * `true`: The entitlement level corresponds to unlimited units of the feature. `levels[].value` is ignored for this level. This can only be set for the level that has the highest value for `levels[].level.`
            * `false`: The entitlement level does not correspond to unlimited units of the feature.
          example: null
      required:
      - is_unlimited
      - level
      - value
      example: null
    Media:
      type: object
      description: |
        A media artifact uploaded to Chargebee.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            The unique identifier for the media file. This is auto-generated by Chargebee.
          maxLength: 42
          minLength: 8
          example: null
        url:
          type: string
          deprecated: false
          description: |
            The public URL for accessing the media file. This is auto-generated by Chargebee.
          maxLength: 512
          minLength: 10
          example: null
        alt_text:
          type: string
          deprecated: false
          description: |
            The [alternative text](https://webaim.org/techniques/alttext/)
            for the image. Applicable only when the top-level `media_type`
            is `image`
            .
          maxLength: 128
          minLength: 2
          example: null
        media_type:
          type: string
          deprecated: false
          description: |
            The [media type](https://en.wikipedia.org/wiki/Media_type)
            of the file.
          maxLength: 20
          example: null
      required:
      - id
      example: null
    Metadata:
      type: object
      properties:
        change_type:
          type: string
          deprecated: false
          maxLength: 100
          example: null
      example: null
    Meter:
      type: object
      description: |
        A **meter** captures the usage measurement configuration of a [metered feature](/docs/api/metered_features).
      properties:
        id:
          type: string
          deprecated: false
          description: |
            A unique identifier for the meter. This is the same as `feature.id`.
          maxLength: 50
          example: null
        name:
          type: string
          deprecated: false
          description: |
            A case-sensitive name for the meter. For example: `API Calls`, `Input Tokens`.
          maxLength: 50
          example: null
        description:
          type: string
          deprecated: false
          description: |
            A brief description of the meter.
          maxLength: 500
          example: null
        type:
          type: string
          deprecated: false
          description: |
            The type of meter that determines how usage is measured for the meter.

            * compound - Usage is computed from a mathematical formula combining other meters.
            * simple - Usage is computed from the SQL `query` over [`usage_event`](/docs/api/usage_events) properties.
          enum:
          - simple
          - compound
          example: null
        status:
          type: string
          deprecated: false
          description: |
            The current status of the meter.

            * active - The meter is active and **new** entitlements can be created towards it.
            * deleted - The meter has been permanently deleted.
            * archived - No **new** entitlements can be created towards the meter. However, any pre-existing entitlements from the time that the meter was `active` remain effective.
          enum:
          - active
          - archived
          - deleted
          example: null
        query:
          type: string
          deprecated: false
          description: |
            The SQL query used to measure usage from [`usage_event`](/docs/api/usage_events) properties. For example: `SELECT SUM(api_calls) FROM events`.
          maxLength: 500
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            When the meter was created.
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            When the meter was last updated.
          example: null
        column_definitions:
          type: array
          deprecated: false
          description: |
            Definitions of the columns or properties referenced by the meter's `query`. Each entry describes one column used to measure usage.
          items:
            type: object
            deprecated: false
            properties:
              column_name:
                type: string
                deprecated: false
                description: |
                  Name of the column or property used in the `query`. For example, `request_count` or `input_tokens`.
                maxLength: 100
                example: null
              data_type:
                type: string
                deprecated: false
                description: |
                  Data type of the column or property.

                  * string - The column or property holds a string value.
                  * number - The column or property holds a numeric value.
                enum:
                - number
                - string
                example: null
            required:
            - column_name
            - data_type
            example: null
          example: null
        features:
          type: array
          deprecated: false
          description: |
            The [feature](/docs/api/features) associated with this meter. This array has only one element since any given meter is associated with only one feature.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  A unique and immutable identifier for the feature. This is the same as `meter.id`.
                maxLength: 50
                example: null
              name:
                type: string
                deprecated: false
                description: |
                  A case-sensitive unique name for the feature.
                maxLength: 50
                example: null
              description:
                type: string
                deprecated: false
                description: |
                  A brief description of the feature.
                maxLength: 500
                example: null
              status:
                type: string
                deprecated: false
                description: |
                  The current status of the feature.

                  * draft - This value is not applicable for metered features.
                  * active - The feature is published. Any [entitlements](/docs/api/entitlements) or [subscription entitlements](/docs/api/subscription_entitlements) defined for the feature take effect immediately.
                  * archived - No **new** [entitlements](/docs/api/entitlements) or [subscription entitlements](/docs/api/subscription_entitlements) can be created for the feature. However, any pre-existing item or subscription entitlements from the time that the feature was `active` remain effective.
                enum:
                - active
                - archived
                - draft
                example: null
              type:
                type: string
                deprecated: false
                description: |
                  The type of feature. The value is always `range`.

                  * custom - This value is not applicable for metered features.
                  * range - The feature is quantity based, with entitlement levels between `1` and `unlimited`.
                  * quantity - This value is not applicable for metered features.
                  * switch - This value is not applicable for metered features.
                enum:
                - switch
                - custom
                - quantity
                - range
                example: null
              unit:
                type: string
                deprecated: false
                description: |
                  Specifies the unit of measure. The value is expected in the singular form. It is pluralized automatically as needed. For example, for a feature such as `user licenses`, the `unit` can be `license`.
                maxLength: 50
                example: null
              resource_version:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The version number of this resource. For every change made to the resource, `resource_version` is updated with a new timestamp in milliseconds.
                example: null
              updated_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  When the feature was last updated.
                example: null
              created_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  When the feature was created.
                example: null
              metered:
                type: boolean
                deprecated: false
                description: |
                  Indicates whether the feature is metered. Always `true`.
                example: null
              levels:
                type: array
                deprecated: false
                description: |
                  An ordered list of entitlement levels available for the feature.
                items:
                  type: object
                  deprecated: false
                  properties:
                    name:
                      type: string
                      deprecated: false
                      description: |
                        A case-sensitive display name for the entitlement level.
                      maxLength: 100
                      example: null
                    value:
                      type: string
                      deprecated: false
                      description: |
                        Always `1` for `levels[0]` and `unlimited` for `levels[1]`.
                      maxLength: 50
                      example: null
                    level:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        This attribute represents the order of the entitlement levels from lowest to highest.
                      example: null
                    is_unlimited:
                      type: boolean
                      deprecated: false
                      description: |
                        Always `true` for `levels[1]` and `false` for `levels[0]`.
                      example: null
                  required:
                  - is_unlimited
                  - level
                  - value
                  example: null
                example: null
            required:
            - created_at
            - id
            - metered
            - name
            example: null
          example: null
      required:
      - created_at
      - id
      - name
      - query
      - type
      example: null
    MeterType:
      type: string
      deprecated: true
      enum:
      - simple
      - compound
      example: null
    MeteredFeature:
      type: object
      description: |
        A metered feature object represents two things:

        * the [feature](/docs/api/features) whose entitlement is consumed based on measured usage.
        * the configuration that measures that usage.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            A unique identifier for the metered feature. This is the same as `feature.id`.
          maxLength: 50
          example: null
        name:
          type: string
          deprecated: false
          description: |
            A case-sensitive name for the metered feature. For example: `API Calls`, `Input Tokens`.
          maxLength: 50
          example: null
        description:
          type: string
          deprecated: false
          description: |
            A brief description of the metered feature.
          maxLength: 250
          example: null
        type:
          type: string
          deprecated: false
          description: |
            The type of meter. Determines how usage is measured for the metered feature.

            * compound - Usage is computed from a mathematical formula combining other meters.
            * simple - Usage is computed from a SQL `query` over [`usage_event`](/docs/api/usage_events) properties.
          enum:
          - simple
          - compound
          example: null
        status:
          type: string
          deprecated: false
          description: |
            The current status of the metered feature.

            * active - The metered feature is active and **new** [entitlements](/docs/api/entitlements) and [subscription entitlements](/docs/api/subscription_entitlements) can be created for it.
            * deleted - The metered feature has been permanently deleted.
            * archived - No **new** [entitlements](/docs/api/entitlements) and [subscription entitlements](/docs/api/subscription_entitlements) can be created for the metered feature. However, any pre-existing entitlements and subscription entitlements remain effective.
          enum:
          - active
          - archived
          - deleted
          example: null
        query:
          type: string
          deprecated: false
          description: "The SQL query used to measure usage from [`usage_event`](/docs/api/usage_events)\
            \ properties. For example: `SELECT SUM(api_calls) FROM events`.  \n**Constraint**:\n\
            \n* The properties referenced in the query are always one of `column_definitions.column_name`.\n"
          maxLength: 1000
          example: null
        column_definitions:
          type: array
          deprecated: false
          description: |
            Definitions of the columns or properties referenced by the metered feature's `query`.
          items:
            type: object
            deprecated: false
            properties:
              column_name:
                type: string
                deprecated: false
                description: |
                  Name of the column or property used in the `query`. For example, `request_count` or `input_tokens`.
                maxLength: 100
                example: null
              data_type:
                type: string
                deprecated: false
                description: |
                  Data type of the column or property.

                  * string - The column or property holds a string value.
                  * number - The column or property holds a numeric value.
                enum:
                - number
                - string
                example: null
            required:
            - column_name
            - data_type
            example: null
          example: null
        features:
          type: array
          deprecated: false
          description: |
            The [feature](/docs/api/features) associated with this metered feature. This array has only one element since any given metered feature is associated with only one feature.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  A unique and immutable identifier for the feature. This is the same as `id`.
                maxLength: 50
                example: null
              name:
                type: string
                deprecated: false
                description: |
                  A case-sensitive unique name for the feature.
                maxLength: 50
                example: null
              description:
                type: string
                deprecated: false
                description: |
                  A brief description of the feature.
                maxLength: 500
                example: null
              status:
                type: string
                deprecated: false
                description: |
                  The current status of the feature.

                  * draft - This value is not applicable for metered features.
                  * active - The feature is active. Any [entitlements](/docs/api/entitlements) or [subscription entitlements](/docs/api/subscription_entitlements) defined for the feature take effect immediately.
                  * archived - No **new** [entitlements](/docs/api/entitlements) or [subscription entitlements](/docs/api/subscription_entitlements) can be created for the feature. However, any pre-existing entitlements and subscription entitlements remain effective.
                enum:
                - active
                - archived
                - draft
                example: null
              type:
                type: string
                deprecated: false
                description: |
                  The type of feature. The value is always `range`.

                  * custom - This value is not applicable for metered features.
                  * range - The feature is quantity based, with entitlement levels between `1` and `unlimited`.
                  * quantity - This value is not applicable for metered features.
                  * switch - This value is not applicable for metered features.
                enum:
                - switch
                - custom
                - quantity
                - range
                example: null
              unit:
                type: string
                deprecated: false
                description: |
                  Specifies the unit of measure. The value is expected in the singular form. It is pluralized automatically as needed. For example, for a feature such as `API Calls`, the `unit` can be `request`.
                maxLength: 50
                example: null
              resource_version:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The version number of this resource. For every change made to the resource, `resource_version` is updated with a new timestamp in milliseconds.
                example: null
              updated_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  When the feature was last updated.
                example: null
              created_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  When the feature was created.
                example: null
              metered:
                type: boolean
                deprecated: false
                description: |
                  Indicates whether the feature is metered. The value is always `true`.
                example: null
              levels:
                type: array
                deprecated: false
                description: |
                  An ordered list of entitlement levels available for the feature.
                items:
                  type: object
                  deprecated: false
                  properties:
                    name:
                      type: string
                      deprecated: false
                      description: |
                        A case-sensitive display name for the entitlement level.
                      maxLength: 100
                      example: null
                    value:
                      type: string
                      deprecated: false
                      description: |
                        Always `1` for `levels[0]` and `unlimited` for `levels[1]`.
                      maxLength: 50
                      example: null
                    level:
                      type: integer
                      format: int32
                      deprecated: false
                      description: |
                        This attribute represents the order of the entitlement levels from lowest to highest.
                      example: null
                    is_unlimited:
                      type: boolean
                      deprecated: false
                      description: |
                        Always `true` for `levels[1]` and `false` for `levels[0]`.
                      example: null
                  required:
                  - is_unlimited
                  - level
                  - value
                  example: null
                example: null
            required:
            - created_at
            - id
            - metered
            - name
            example: null
          example: null
      required:
      - 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:**

        * We've stopped giving access to the legacy solution due to the limitations mentioned [here](https://www.chargebee.com/docs/billing/2.0/mobile-subscriptions/mobile-subscriptions-limitations). Please [request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/omnichannel-subscription&ref=feature) for enabling the new [Omnichannel Subscriptions](/docs/api/recorded_purchases/recorded-purchase-object) solution.
        * 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: |
            The [`subscription_item.item_price_id`](/docs/api/subscriptions/subscription-object#item_tiers_item_price_id) where the `item_type` is `charge`.
          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: |
        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.

        **Features of this object:**

        * Records fulfillment IDs for tracking and reference.
        * Captures status (`in_progress`, `completed`, `failed`).
        * Stores redirect/checkout URLs as needed.
        * Contains timestamps for creation, completion, or failure.
        * Includes error codes and messages for failure analysis.
      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 your system
            * email - Chargebee sends an email as configured in the Growth application and the fulfillment is processed by your system
            * checkout - The offer fulfillment is processed using Chargebee hosted checkout
            * url_redirect - The offer fulfillment is processed by your 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: |
            Current status of the offer fulfillment process.

            * in_progress - The offer fulfillment is underway (not yet completed).
            * completed - 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.
            * failed -
              The offer fulfillment failed. The `error object`
              field will be present to provide more details in this case.
          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 your system, 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 your 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
    OmnichannelOneTimeOrder:
      type: object
      description: "Represents a one-time in-app product purchase from Apple App Store\
        \ or Google Play Store, normalized into Chargebee's omnichannel model.\n\n\
        Omnichannel one-time orders are typically created when you [record a purchase](/docs/api/recorded_purchases/record-a-purchase)\
        \ and may be updated via store notifications (for example, refunds). Unlike\
        \ subscriptions, one-time order items do not carry a recurring `status` field;\
        \ cancellation is expressed via item `cancelled_at` / `cancellation_reason`.\n\
        \n**Apple App Store** : Parent `id_at_source` is the **Transaction ID** .\
        \ Nested `purchase_transaction.id_at_source` is the same Transaction ID for\
        \ the purchase row.\n\n**Google Play Store** : Parent `id_at_source` is the\
        \ **purchase token** . Nested `purchase_transaction.id_at_source` is the **Order\
        \ ID** (`GPA....`).\n\nSee [omnichannel events](/docs/api/omnichannel_events)\
        \ for recording and cancel mappings, and [`omnichannel_transaction`](/docs/api/omnichannel_transactions)\
        \ for price / `transacted_at` guidance.  \n**Note:**\nThis resource specifically\
        \ represents in-app product purchases made via the Apple App Store and Google\
        \ Play Store.\n"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            The ID generated by Chargebee for the recorded one-time order.
          maxLength: 40
          example: null
        app_id:
          type: string
          deprecated: false
          description: |
            App Identifier in Chargebee. This is the handle created by Chargebee for your app. To get the `app_id`:

            * For **Apple** , follow [these steps](https://www.chargebee.com/docs/billing/2.0/mobile-subscriptions/omnichannel-app-store#create-an-omnichannel-subscription-for-in-app-purchases).
            * For **Google** , follow [these steps](https://www.chargebee.com/docs/billing/2.0/mobile-subscriptions/omnichannel-play-store#connect-google-app-to-chargebee-to-generate-unique-app-id-and-notifications-url).
          maxLength: 100
          example: null
        customer_id:
          type: string
          deprecated: false
          description: |
            The `id`
            of the [customer](/docs/api/customers/customer-object#id)
            object that is associated with this one-time order.
          maxLength: 100
          example: null
        id_at_source:
          type: string
          deprecated: false
          description: |
            The store-native identifier for this one-time order.

            **Apple App Store** : The App Store **Transaction ID** for the purchase (same value as `purchase_transaction.id_at_source` for the initial purchase row).

            **Google Play Store** : The Google Play **purchase token** for the one-time product purchase --- not the **Order ID** . The Order ID (`GPA....`) is on `purchase_transaction.id_at_source`.
          maxLength: 500
          example: null
        origin:
          type: string
          deprecated: false
          description: |
            Country code indicating where the one-time order originated, such as `US`
            for the United States.
          maxLength: 3
          example: null
        source:
          type: string
          deprecated: false
          description: |
            The storefront where the one-time order was originally made and managed (`apple_app_store` or `google_play_store`).

            * google_play_store - The source of the app is `google_play_store`.
            * apple_app_store - The source of the app is `apple_app_store`.
          enum:
          - apple_app_store
          - google_play_store
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp when the `omnichannel_one_time_order` was created in Chargebee.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            Version number of this resource. The `resource_version`
            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.
          example: null
        omnichannel_one_time_order_items:
          type: array
          deprecated: false
          description: |
            List of `omnichannel_one_time_order_item` objects in the one-time order.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  Uniquely identifies an `omnichannel_one_time_order_item`.
                maxLength: 40
                example: null
              item_id_at_source:
                type: string
                deprecated: false
                description: |
                  Product identifier of the purchased item in the source store.

                  **Apple App Store**: App Store Connect product identifier (consumable, non-consumable, or non-renewing subscription product).

                  **Google Play Store**: Google Play in-app product ID for the one-time product.
                maxLength: 100
                example: null
              item_type_at_source:
                type: string
                deprecated: false
                description: |
                  Product type as reported by the source store.

                  **Apple App Store**: Typically values such as consumable, non-consumable, or non-renewing subscription product types from App Store Connect / StoreKit.

                  **Google Play Store**: Typically the Google Play one-time product / in-app product type context.
                maxLength: 100
                example: null
              quantity:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The quantity of the omnichannel order item(s) purchased by the customer.
                example: null
              cancelled_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Timestamp when this specific `omnichannel_one_time_order_item`
                  was cancelled in the `source`.
                example: null
              cancellation_reason:
                type: string
                deprecated: false
                description: |
                  The reason this `omnichannel_one_time_order_item` was cancelled (for example, refunded or revoked).

                  * merchant_revoked -
                    The merchant revoked the one-time purchase / access.

                    **Google Play Store**: Commonly used for voided / revoked purchases.

                    **Apple App Store**: Can apply when access is revoked.
                  * refunded_for_other_reason -
                    The one-time purchase was refunded for another reason.

                    **Apple App Store**: Commonly set for refund notifications with a non-app-issue refund reason.

                    **Google Play Store**: Not typically used for this reason code.
                  * refunded_due_to_app_issue -
                    The one-time purchase was refunded due to an app issue.

                    **Apple App Store**: Commonly set for refund notifications with an app-issue refund reason.

                    **Google Play Store**: Not typically used for this reason code.
                  * customer_cancelled - The customer cancelled / requested refund of the one-time purchase where the store reports a customer-initiated context.
                  * customer_did_not_consent_to_price_increase - Not typically applicable to one-time orders; reserved for parity with subscription cancellation reasons.
                enum:
                - customer_cancelled
                - customer_did_not_consent_to_price_increase
                - refunded_due_to_app_issue
                - refunded_for_other_reason
                - merchant_revoked
                example: null
              created_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Timestamp when the `omnichannel_one_time_order_item` was created in Chargebee.
                example: null
              resource_version:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Version number of this resource. The `resource_version`
                  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.
                example: null
            required:
            - created_at
            - id
            - item_id_at_source
            example: null
          example: null
        purchase_transaction:
          type: object
          deprecated: false
          description: |
            Details of the purchase transaction associated with the one-time order.
          properties:
            id:
              type: string
              deprecated: false
              description: |
                Unique identifier for the `omnichannel_transaction`.
              maxLength: 40
              example: null
            id_at_source:
              type: string
              deprecated: false
              description: |
                The store-native identifier for this transaction.

                **Apple App Store** : **Transaction ID** for this purchase.

                **Google Play Store** : **Order ID** for this purchase (typically `GPA....`). This is not the parent one-time order purchase token (`omnichannel_one_time_order.id_at_source`).
              maxLength: 100
              example: null
            app_id:
              type: string
              deprecated: false
              description: |
                App Identifier in Chargebee. This is the handle created by Chargebee for your app. To get the `app_id`:

                * For **Apple** , follow [these steps](https://www.chargebee.com/docs/billing/2.0/mobile-subscriptions/omnichannel-app-store#create-an-omnichannel-subscription-for-in-app-purchases).
                * For **Google** , follow [these steps](https://www.chargebee.com/docs/billing/2.0/mobile-subscriptions/omnichannel-play-store#connect-google-app-to-chargebee-to-generate-unique-app-id-and-notifications-url).
              maxLength: 100
              example: null
            price_currency:
              type: string
              deprecated: false
              description: |
                The three-letter ISO 4217 currency code associated with the transaction (`price_currency`), when price data is available.
              maxLength: 3
              example: null
            price_units:
              type: integer
              format: int64
              deprecated: false
              description: |
                The whole units of the amount, when price data is available.
                For example:
                if `price_currency` is **USD** (two-decimal currency), then the unit value for **USD** **1.23** will be **1**
                if `price_currency` is **JPY** (zero-decimal currency), then the unit value for **JPY** **123** will be **123**
                if `price_currency` is **BHD** (three-decimal currency), then the unit value for **BHD** **1.234** will be **1**
              example: null
            price_nanos:
              type: integer
              format: int64
              deprecated: false
              description: |
                The fractional price amount, in nanos (billionths of the currency unit), when price data is available.
                The value must be between **0** and **+999,999,999** inclusive.
                For example:
                If `price_currency` is **USD** (two-decimal currency), then nanos value for **USD** **1.23** will be **230,000,000**
                If `price_currency` is **JPY** (zero-decimal currency), then nanos value for **JPY** **123** will be **0**
                If `price_currency` is **BHD** (three-decimal currency), then nanos value for **BHD** **1.234** will be **234,000,000**

                **Apple App Store**: Typically present.

                **Google Play Store**: May be present when Google provides price data for the transaction; otherwise absent.
              example: null
            type:
              type: string
              deprecated: false
              description: |
                The type of transaction that occurred in the `source`.

                * renewal - Indicates that the transaction was initiated as part of a renewal for a previously completed purchase. Not used for one-time orders.
                * purchase - Indicates that the transaction occurred for a purchase.
              enum:
              - purchase
              - renewal
              example: null
            transacted_at:
              type: integer
              format: unix-time
              deprecated: false
              description: |
                Timestamp when the transaction occurred in the `source`, when available.

                **Apple App Store**: Typically present.

                **Google Play Store**: May be present when Google provides purchase time; otherwise absent.
              example: null
            created_at:
              type: integer
              format: unix-time
              deprecated: false
              description: |
                Timestamp when the transaction was created in Chargebee.
              example: null
            resource_version:
              type: integer
              format: int64
              deprecated: false
              description: |
                Version number of this resource. The `resource_version`
                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.
              example: null
            linked_omnichannel_subscriptions:
              type: array
              deprecated: false
              description: |
                A list of `omnichannel_subscription`
                objects linked to this transaction.
              items:
                type: object
                deprecated: false
                properties:
                  omnichannel_subscription_id:
                    type: string
                    deprecated: false
                    description: |
                      The `id` of a linked [`omnichannel_subscription`](/docs/api/omnichannel_subscriptions/omnichannel_subscription-object#id).
                    maxLength: 100
                    example: null
                example: null
              example: null
            linked_omnichannel_one_time_orders:
              type: array
              deprecated: false
              description: |
                A list of `omnichannel_one_time_order`
                objects linked to this transaction.
              items:
                type: object
                deprecated: false
                properties:
                  omnichannel_one_time_order_id:
                    type: string
                    deprecated: false
                    description: |
                      The `id` of a linked [`omnichannel_one_time_order`](/docs/api/omnichannel_one_time_orders/omnichannel_one_time_order-object#id).
                    maxLength: 100
                    example: null
                example: null
              example: null
          required:
          - app_id
          - created_at
          - id
          - id_at_source
          - type
          example: null
      required:
      - app_id
      - created_at
      - id
      - id_at_source
      - omnichannel_one_time_order_items
      - source
      example: null
    OmnichannelOneTimeOrderCreatedEvent:
      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:
            omnichannel_one_time_order:
              $ref: "#/components/schemas/OmnichannelOneTimeOrder"
            omnichannel_one_time_order_item:
              $ref: "#/components/schemas/OmnichannelOneTimeOrderItem"
            omnichannel_transaction:
              $ref: "#/components/schemas/OmnichannelTransaction"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_one_time_order
          - omnichannel_one_time_order_item
          - omnichannel_transaction
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelOneTimeOrderItem:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 40
          example: null
        item_id_at_source:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        item_type_at_source:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        quantity:
          type: integer
          format: int32
          deprecated: false
          example: null
        cancelled_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        cancellation_reason:
          type: string
          deprecated: false
          enum:
          - customer_cancelled
          - customer_did_not_consent_to_price_increase
          - refunded_due_to_app_issue
          - refunded_for_other_reason
          - merchant_revoked
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          example: null
      required:
      - created_at
      - id
      - item_id_at_source
      example: null
    OmnichannelOneTimeOrderItemCancelledEvent:
      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:
            omnichannel_one_time_order:
              $ref: "#/components/schemas/OmnichannelOneTimeOrder"
            omnichannel_one_time_order_item:
              $ref: "#/components/schemas/OmnichannelOneTimeOrderItem"
            omnichannel_transaction:
              $ref: "#/components/schemas/OmnichannelTransaction"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_one_time_order
          - omnichannel_one_time_order_item
          - omnichannel_transaction
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelSubscription:
      type: object
      description: "Represents a subscription purchased and managed in an external\
        \ app marketplace (`apple_app_store` or `google_play_store`), normalized into\
        \ Chargebee's omnichannel model.\n\nOmnichannel subscriptions are typically\
        \ created when you [record a purchase](/docs/api/recorded_purchases/record-a-purchase)\
        \ and are kept in sync via store server notifications. They are store-managed:\
        \ lifecycle changes come from Apple or Google, not from the Chargebee Subscriptions\
        \ API.\n\nUse [omnichannel statuses](/docs/api/omnichannel_statuses) for how\
        \ store statuses map to `omnichannel_subscription_item.status`, and [omnichannel\
        \ events](/docs/api/omnichannel_events) for notification-to-webhook mappings.\
        \  \n**Identifier tip:** Parent `id_at_source` is the Apple **Transaction\
        \ ID** or Google **purchase token** . Nested `initial_purchase_transaction.id_at_source`\
        \ is the Apple **Transaction ID** or Google **Order ID** (`GPA....`). See\
        \ attribute descriptions below.  \n**Note:**\nThis resource represents in-app\
        \ subscriptions made on Apple App Store and Google Play Store.\n"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            The ID generated by Chargebee for the omnichannel subscription.
          maxLength: 50
          example: null
        id_at_source:
          type: string
          deprecated: false
          description: |
            The identifier of the subscription in the `source`.

            **Apple App Store** : The original purchase **Transaction ID** (stable for the subscription lifecycle).

            **Google Play Store** : The subscription **purchase token** . This value can change when Google issues a new token after certain subscription changes; Chargebee updates `id_at_source` to the latest token.
            > **Note:** Do not confuse this with `initial_purchase_transaction.id_at_source`. For Google, the nested transaction uses the **Order ID** (`GPA....`), not the purchase token.
          maxLength: 500
          example: null
        app_id:
          type: string
          deprecated: false
          description: |
            App Identifier in Chargebee. This is the handle created by Chargebee for your app. To get the `app_id`:

            * For **Apple** , follow [these steps](https://www.chargebee.com/docs/billing/2.0/mobile-subscriptions/omnichannel-app-store#create-an-omnichannel-subscription-for-in-app-purchases).
            * For **Google** , follow [these steps](https://www.chargebee.com/docs/billing/2.0/mobile-subscriptions/omnichannel-play-store#connect-google-app-to-chargebee-to-generate-unique-app-id-and-notifications-url).
          maxLength: 100
          example: null
        source:
          type: string
          deprecated: false
          description: |
            The storefront where the purchase is originally made and managed (`apple_app_store` or `google_play_store`).

            * google_play_store - The purchase originated from the Google Play Store.
            * apple_app_store - The purchase originated from the Apple App Store.
          enum:
          - apple_app_store
          - google_play_store
          example: null
        customer_id:
          type: string
          deprecated: false
          description: |
            The `id`
            of the [customer](/docs/api/customers/customer-object#id)
            object that is associated with this purchase.
          maxLength: 100
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp when the `omnichannel_subscription` was created in Chargebee.
          example: null
        purchased_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp (UTC) when the subscription was originally purchased in the app marketplace (initial purchase). This corresponds to the time of the initial purchase transaction in the [`source`](/docs/api/omnichannel_subscriptions/omnichannel_subscription-object#source).
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Indicates timestamp when the `omnichannel_subscription` was last updated
            .
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            Version number of this resource. The `resource_version`
            is updated with a new timestamp in milliseconds for every change made to the resource.
          example: null
        omnichannel_subscription_items:
          type: array
          deprecated: false
          description: |
            Items associated with the omnichannel_subscription.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  Uniquely identifies an `omnichannel_subscription_item`.
                maxLength: 40
                example: null
              item_id_at_source:
                type: string
                deprecated: false
                description: |
                  Product identifier of this subscription item in the source store.

                  **Apple App Store**: The App Store Connect product identifier.

                  **Google Play Store** : The Google Play product / base-plan identifier associated with the active entitlement. See also `item_parent_id_at_source` when a parent/child hierarchy applies.
                maxLength: 100
                example: null
              item_parent_id_at_source:
                type: string
                deprecated: false
                description: |
                  Parent product identifier in the source store, when the store exposes a parent/child product hierarchy.

                  **Apple App Store**: Typically the subscription group / parent product context when applicable.

                  **Google Play Store**: Typically the parent product ID associated with the base plan / offer hierarchy when applicable.
                maxLength: 100
                example: null
              status:
                type: string
                deprecated: false
                description: |
                  Status of the `omnichannel_subscription_item`. Status lives on the item, not on the parent subscription.
                  [Learn more](/docs/api/omnichannel_statuses) about status and store mappings.

                  * active -
                    The subscription item is active and entitled for the current term.

                    **Google Play Store** : Also used when Google has canceled auto-renew but the term has not ended (`auto_renew_status` = `off`).
                  * in_dunning - Billing is retrying after a payment failure and access may be restricted (Apple billing retry / Google account hold).
                  * expired - The subscription item expired for a non-cancellation reason. See `expiration_reason`.
                  * cancelled - The subscription item is cancelled (entitlement ended due to cancellation / revoke / refund contexts). See `cancellation_reason`.
                  * in_grace_period - Billing is retrying during a grace period; service should typically continue.
                  * paused - The subscription item is paused. See `resumes_at` when available.
                enum:
                - active
                - expired
                - cancelled
                - in_dunning
                - in_grace_period
                - paused
                example: null
              auto_renew_status:
                type: string
                deprecated: false
                description: |
                  Whether the subscription item is set to auto-renew at the end of the current term (`on` or `off`).

                  **Google Play Store** : When the customer cancels but remains in-term, `status` stays `active` and `auto_renew_status` is `off`.

                  * off - Auto-renewal is disabled for the `omnichannel_subscription_item`.
                  * on - Auto-renewal is enabled for the `omnichannel_subscription_item`.
                enum:
                - "off"
                - "on"
                example: null
              current_term_start:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Start of the current billing period of the subscription item. It is applicable only if the [`status`](/docs/api/omnichannel_subscriptions/omnichannel_subscription-object#omnichannel_subscription_items)
                  is `active`
                  .
                example: null
              current_term_end:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  End of the current billing period of the subscription item. Applicable when [`status`](/docs/api/omnichannel_subscription_items/omnichannel_subscription_item-object#status) is `active`.

                  **Apple App Store** : Closest analogue to [`next_billing_at`](/docs/api/subscriptions/subscription-object#next_billing_at) because Apple does not expose a separate next-renewal timestamp. Apple may renew up to 24 hours before expiry and, in billing retry, may retry for up to 60 days. [Learn more](https://developer.apple.com/documentation/storekit/in-app_purchase/original_api_for_in-app_purchase/subscriptions_and_offers/handling_subscriptions_billing#3221910).

                  **Google Play Store** : Corresponds to the subscription expiry / next billing boundary from Play. When the customer has canceled but the term has not ended, `status` remains `active` with `auto_renew_status` = `off` (see [omnichannel statuses](/docs/api/omnichannel_statuses)).
                example: null
              expired_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Indicates timestamp when the subscription associated with the `omnichannel_subscription_item`
                  was `expired`
                  in the [`source`](/docs/api/omnichannel_subscriptions/omnichannel_subscription-object#source)
                example: null
              expiration_reason:
                type: string
                deprecated: false
                description: |
                  Specifies the reason for the subscription expiration. Present when `status` is `expired`.

                  **Apple App Store** : Commonly maps from Apple expiration intents such as `BILLING_ERROR`, `PRODUCT_NOT_AVAILABLE`, and `OTHER`.

                  **Google Play Store** : User-initiated and merchant-revoked expirations typically map to `cancelled` with a `cancellation_reason` instead of `expired`.

                  * product_not_available -
                    The product was unavailable for purchase at the time of renewal.

                    **Apple App Store** : Maps from expiration intent `PRODUCT_NOT_AVAILABLE`.
                  * other -
                    The subscription associated with the item expired for an unspecified reason.

                    **Apple App Store** : Maps from expiration intent `OTHER`.
                  * billing_error -
                    Billing error, such as invalid customer payment information.

                    **Apple App Store** : Maps from expiration intent `BILLING_ERROR`.
                enum:
                - billing_error
                - product_not_available
                - other
                - subscription_not_found_in_source
                example: null
              cancelled_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Indicates timestamp when the subscription associated with the `omnichannel_subscription_item`
                  was `cancelled`
                  in the [`source`](/docs/api/omnichannel_subscriptions/omnichannel_subscription-object#source)
                example: null
              cancellation_reason:
                type: string
                deprecated: false
                description: |
                  The reason the subscription item was cancelled. Present when `status` is `cancelled`. Store applicability varies by enum value.

                  * customer_did_not_consent_to_price_increase -
                    The customer did not consent to a price increase for the subscription item.

                    **Apple App Store** : Maps from expiration intent `CUSTOMER_DID_NOT_CONSENT_TO_PRICE_INCREASE`.

                    **Google Play Store**: Not typically used for this reason code.
                  * merchant_revoked -
                    The merchant revoked access to the subscription.

                    **Apple App Store** : Can apply when access is revoked (for example, `REVOKED` / related refund revoke flows).

                    **Google Play Store** : Commonly maps from revoke / chargeback-style contexts (for example, `SUBSCRIPTION_REVOKED`).
                  * customer_cancelled -
                    The customer voluntarily cancelled the subscription.

                    **Apple App Store** : Commonly maps from expiration intent `CUSTOMER_CANCELLED`.

                    **Google Play Store**: Commonly maps from user-initiated cancellation / cancel-at-term-end flows.
                  * refunded_for_other_reason -
                    The subscription was cancelled and refunded for another reason.

                    **Apple App Store**: Commonly set for refund notifications with a non-app-issue refund reason.

                    **Google Play Store**: Not typically used for this reason code.
                  * refunded_due_to_app_issue -
                    The subscription was cancelled and refunded due to an app issue.

                    **Apple App Store**: Commonly set for refund notifications with an app-issue refund reason.

                    **Google Play Store**: Not typically used for this reason code.
                enum:
                - customer_cancelled
                - customer_did_not_consent_to_price_increase
                - refunded_due_to_app_issue
                - refunded_for_other_reason
                - merchant_revoked
                example: null
              grace_period_expires_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Timestamp when the grace period for the `omnichannel_subscription_item` expires in the `source`.

                  **Apple App Store** : Present when the item is in `in_grace_period` (Apple billing grace period).

                  **Google Play Store** : Present when the item is in `in_grace_period` (`SUBSCRIPTION_STATE_IN_GRACE_PERIOD`).
                example: null
              resumes_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Timestamp when the subscription automatically resumes after being set to `paused`.

                  **Google Play Store**: Typically present for paused subscriptions.

                  **Apple App Store**: Pause is not generally applicable in the same way; this attribute is usually absent.
                example: null
              has_scheduled_changes:
                type: boolean
                default: false
                deprecated: false
                description: |
                  Indicates whether the `omnichannel_subscription_item`
                  has any scheduled changes. When `true`, use [List scheduled changes for an omnichannel subscription item](/docs/api/omnichannel_subscription_items/list-scheduled-changes-for-omnichannel-subscription-item) to retrieve them.
                example: null
              updated_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Indicates timestamp when the `omnichannel_subscription_item`
                  was last updated in Chargebee.
                example: null
              resource_version:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Version number of this resource. The `resource_version`
                  is updated with a new timestamp in milliseconds for every change made to the resource.
                example: null
              omnichannel_subscription_item_offers:
                type: array
                deprecated: false
                description: |
                  Represents the `omnichannel_subscription_item_offers`
                  associated with the `omnichannel_subscription_item`
                  .
                items:
                  type: object
                  deprecated: false
                  properties:
                    id:
                      type: string
                      deprecated: false
                      description: |
                        Unique identifier for the `omnichannel_subscription_item_offer`.
                        System-generated.
                      maxLength: 40
                      example: null
                    offer_id_at_source:
                      type: string
                      deprecated: false
                      description: |
                        Identifier of the offer on the source platform (for example, Apple App Store or Google Play Store). Used to map Chargebee's record to the source.
                      maxLength: 100
                      example: null
                    category:
                      type: string
                      deprecated: false
                      description: |
                        Indicates functional purpose of the offer. For example, `introductory`
                        indicates a first-time offer for new subscribers.

                        * introductory - Introductory offer for first-time subscribers, typically providing special pricing or terms for the first billing cycle.
                        * promotional - Promotional offer that may be available to both new and existing subscribers, often featuring limited-time pricing or terms.
                        * developer_determined -
                          Offer terms are determined by the developer and may include unique pricing or features.
                          **Note:** Support for this category is planned for a future update.
                      enum:
                      - introductory
                      - promotional
                      - developer_determined
                      example: null
                    category_at_source:
                      type: string
                      deprecated: false
                      description: |
                        Category label as defined by the source platform (for example, Apple App Store or Google Play Store). Directly fetched from the source; useful for debugging or platform-specific workflows.
                      maxLength: 100
                      example: null
                    type:
                      type: string
                      deprecated: false
                      description: |
                        Indicates how the offer is applied from a pricing-model perspective.

                        * free_trial - Provides a free trial period. The customer is not charged during the trial; regular billing begins after the trial ends.
                        * pay_up_front - Requires a fixed upfront payment for a defined subscription period, often at a discount. For example, pay for two months in advance.
                        * pay_as_you_go - Applies a recurring discounted price at each billing cycle over multiple renewals, such as on a monthly plan, a discount on the initial purchase, and the next three billing cycles.
                      enum:
                      - free_trial
                      - pay_up_front
                      - pay_as_you_go
                      example: null
                    type_at_source:
                      type: string
                      deprecated: false
                      description: |
                        Offer type as recorded by the source platform (for example, Apple App Store or Google Play Store). Like `category_at_source`, this is useful for tracking and audit.
                      maxLength: 100
                      example: null
                    discount_type:
                      type: string
                      deprecated: false
                      description: |
                        Discount strategy: percentage discount, fixed amount off, or fixed price override.

                        * percentage - Applies a percentage discount on the original price of the subscription item. For example, 20% off.
                        * fixed_amount - Discount that subtracts a fixed amount from the original price of the subscription item.
                        * price - Overrides the original price with a fixed discounted price for the offer term. For example, set the price to $9.99 during the offer.
                      enum:
                      - fixed_amount
                      - percentage
                      - price
                      example: null
                    duration:
                      type: string
                      deprecated: false
                      description: |
                        Indicates how long the offer applies to the subscription. This attribute uses ISO 8601 duration format. For example, `P1M`
                        (1 month), `P7D`
                        (7 days). After this duration, regular pricing resumes.
                      maxLength: 5
                      example: null
                    percentage:
                      type: number
                      format: double
                      deprecated: false
                      description: |
                        Used when `discount_type`
                        is `percentage`.
                        Specifies the discount as a decimal value. For example, a value of 12.5 corresponds to a 12.5% discount.
                      maximum: 100
                      minimum: 0.01
                      example: null
                    price_currency:
                      type: string
                      deprecated: false
                      description: |
                        Three-letter [ISO 4217](https://www.chargebee.com/docs/billing/2.0/site-configuration/supported-currencies)
                        currency code for the offer price (for example, USD, EUR, INR).
                      maxLength: 3
                      example: null
                    price_units:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Whole-unit portion of the offer amount (for example, `10` for $10.00).
                        **Note:** Depending on the discount type, this value can represent different meanings. For a `fixed_amount` discount, it indicates the amount deducted from the original price; for a `price` discount, it reflects the final amount payable by the customer.
                      example: null
                    price_nanos:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Fractional part of the offer amount, expressed in nanos (billionths of the currency unit). For example, `500000000` represents 0.50. Combine with `price_units` to determine the total price (for example, $10.50).
                        **Note:** Depending on the discount type, this value can represent different meanings. For a `fixed_amount` discount, it indicates the amount deducted from the original price; for a `price` discount, it reflects the final amount payable by the customer.
                      example: null
                    offer_term_start:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        Timestamp when the offer becomes effective for the subscription item. It is typically set to the time when the offer is first applied or activated.
                      example: null
                    offer_term_end:
                      type: integer
                      format: unix-time
                      deprecated: false
                      description: |
                        Timestamp when the offer becomes invalid. After this time, regular pricing or terms apply to the subscription item.
                      example: null
                    resource_version:
                      type: integer
                      format: int64
                      deprecated: false
                      description: |
                        Version number of this resource. The `resource_version`
                        is updated with a new timestamp in milliseconds for every change made to the resource.
                      example: null
                  required:
                  - category
                  - duration
                  - id
                  - type
                  example: null
                example: null
              upcoming_renewal:
                type: object
                deprecated: false
                description: |
                  Information about the upcoming renewal price.

                  **Google Play Store** : Present when Google provides renewal price information and [`auto_renew_status`](/docs/api/omnichannel_subscription_items/omnichannel_subscription_item-object#auto_renew_status) is `on`.

                  **Apple App Store**: Not applicable; this field is absent.
                properties:
                  price_currency:
                    type: string
                    deprecated: false
                    description: |
                      The three-letter [ISO 4217](https://www.chargebee.com/docs/supported-currencies.html)
                      currency code in which the next renewal is set to occur (`price_currency`).
                    maxLength: 3
                    example: null
                  price_units:
                    type: integer
                    format: int64
                    deprecated: false
                    description: |
                      The whole units of the amount.
                      For example:
                      if `price_currency` is **USD** (two-decimal currency), then the unit value for **USD** **1.23** will be **1**
                      if `price_currency` is **JPY** (zero-decimal currency), then the unit value for **JPY** **123** will be **123**
                      if `price_currency` is **BHD** (three-decimal currency), then the unit value for **BHD** **1.234** will be **1**
                    example: null
                  price_nanos:
                    type: integer
                    format: int64
                    deprecated: false
                    description: |
                      The fractional price amount, in nanos (billionths of the currency unit), for the next renewal.
                      The value must be between **0** and **+999,999,999** inclusive.
                      For example:
                      If `price_currency` is **USD** (two-decimal currency), then nanos value for **USD** **1.23** will be **230,000,000**
                      If `price_currency` is **JPY** (zero-decimal currency), then nanos value for **JPY** **123** will be **0**
                      If `price_currency` is **BHD** (three-decimal currency), then nanos value for **BHD** **1.234** will be **234,000,000**
                    example: null
                example: null
              linked_item:
                type: object
                deprecated: false
                description: |
                  Represents an active product catalog mapping between an `omnichannel_subscription_item`
                  and a Chargebee `item`.
                  Use this attribute to retrieve entitlements for the `omnichannel_subscription_item`
                  that are associated with the linked Chargebee `item`
                  .
                properties:
                  id:
                    type: string
                    deprecated: false
                    description: |
                      Represents the `item_id`
                      of the Chargebee item linked to the `omnichannel_subscription_item`
                      .
                    maxLength: 100
                    example: null
                  linked_at:
                    type: integer
                    format: unix-time
                    deprecated: false
                    description: |
                      Indicates the timestamp when the mapping between the `omnichannel_subscription_item`
                      and the Chargebee `item`
                      was created in Chargebee.
                    example: null
                required:
                - id
                example: null
            required:
            - has_scheduled_changes
            - id
            - item_id_at_source
            - status
            - updated_at
            example: null
          example: null
        initial_purchase_transaction:
          type: object
          deprecated: false
          description: |
            Refers to the record created when a customer makes their first purchase.
          properties:
            id:
              type: string
              deprecated: false
              description: |
                Unique ID of an `omnichannel_transaction`.
              maxLength: 40
              example: null
            id_at_source:
              type: string
              deprecated: false
              description: |
                The store-native identifier for this transaction.

                **Apple App Store** : **Transaction ID** for this transaction.

                **Google Play Store** : **Order ID** for this transaction (typically `GPA....`). This is not the subscription purchase token (that is the parent `omnichannel_subscription.id_at_source`).
              maxLength: 100
              example: null
            app_id:
              type: string
              deprecated: false
              description: |
                App Identifier in Chargebee. This is the handle created by Chargebee for your app. To get the `app_id`:

                * For **Apple** , follow [these steps](https://www.chargebee.com/docs/billing/2.0/mobile-subscriptions/omnichannel-app-store#create-an-omnichannel-subscription-for-in-app-purchases).
                * For **Google** , follow [these steps](https://www.chargebee.com/docs/billing/2.0/mobile-subscriptions/omnichannel-play-store#connect-google-app-to-chargebee-to-generate-unique-app-id-and-notifications-url).
              maxLength: 100
              example: null
            price_currency:
              type: string
              deprecated: false
              description: |
                The three-letter ISO 4217 currency code associated with the transaction (`price_currency`).
              maxLength: 3
              example: null
            price_units:
              type: integer
              format: int64
              deprecated: false
              description: |
                The whole units of the amount.
                For example:
                if `price_currency` is **USD** (two-decimal currency), then the unit value for **USD** **1.23** will be **1**
                if `price_currency` is **JPY** (zero-decimal currency), then the unit value for **JPY** **123** will be **123**
                if `price_currency` is **BHD** (three-decimal currency), then the unit value for **BHD** **1.234** will be **1**
              example: null
            price_nanos:
              type: integer
              format: int64
              deprecated: false
              description: |
                The fractional price amount, in nanos (billionths of the currency unit).
                The value must be between **0** and **+999,999,999** inclusive.
                For example:
                If `price_currency` is **USD** (two-decimal currency), then nanos value for **USD** **1.23** will be **230,000,000**
                If `price_currency` is **JPY** (zero-decimal currency), then nanos value for **JPY** **123** will be **0**
                If `price_currency` is **BHD** (three-decimal currency), then nanos value for **BHD** **1.234** will be **234,000,000**

                **Apple App Store**: Typically present for purchase and renewal transactions.

                **Google Play Store**: May be present when Google provides price data for the transaction; otherwise absent.
              example: null
            type:
              type: string
              deprecated: false
              description: |
                Omnichannel transaction type that describes this transaction.

                * renewal - Indicates that the transaction was initiated as part of a renewal for a previously completed subscription purchase.
                * purchase - Indicates that the transaction occurred for an initial purchase (subscription or one-time order).
              enum:
              - purchase
              - renewal
              example: null
            transacted_at:
              type: integer
              format: unix-time
              deprecated: false
              description: |
                Timestamp denoting when the transaction occurred in the `source`.

                **Apple App Store**: Typically present.

                **Google Play Store**: May be present when Google provides purchase time for the transaction; otherwise absent.
              example: null
            created_at:
              type: integer
              format: unix-time
              deprecated: false
              description: |
                The timestamp of transaction creation
              example: null
            resource_version:
              type: integer
              format: int64
              deprecated: false
              description: |
                Version number of this resource. The `resource_version`
                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.
              example: null
            linked_omnichannel_subscriptions:
              type: array
              deprecated: false
              description: |
                A list of `omnichannel_subscription`
                objects linked to this transaction. Each entry represents a subscription associated with the transaction.
              items:
                type: object
                deprecated: false
                properties:
                  omnichannel_subscription_id:
                    type: string
                    deprecated: false
                    description: |
                      The `id` of a linked [`omnichannel_subscription`](/docs/api/omnichannel_subscriptions/omnichannel_subscription-object#id).
                    maxLength: 100
                    example: null
                example: null
              example: null
            linked_omnichannel_one_time_orders:
              type: array
              deprecated: false
              description: |
                A list of `omnichannel_one_time_order`
                objects linked to this transaction. Each entry represents a one-time order associated with the transaction.
              items:
                type: object
                deprecated: false
                properties:
                  omnichannel_one_time_order_id:
                    type: string
                    deprecated: false
                    description: |
                      The `id` of a linked [`omnichannel_one_time_order`](/docs/api/omnichannel_one_time_orders/omnichannel_one_time_order-object#id).
                    maxLength: 100
                    example: null
                example: null
              example: null
          required:
          - app_id
          - created_at
          - id
          - id_at_source
          - type
          example: null
      required:
      - app_id
      - created_at
      - id
      - id_at_source
      - omnichannel_subscription_items
      - source
      - updated_at
      example: null
    OmnichannelSubscriptionCreatedEvent:
      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:
            omnichannel_subscription_item:
              $ref: "#/components/schemas/OmnichannelSubscriptionItem"
            omnichannel_subscription:
              $ref: "#/components/schemas/OmnichannelSubscription"
            omnichannel_transaction:
              $ref: "#/components/schemas/OmnichannelTransaction"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_subscription
          - omnichannel_subscription_item
          - omnichannel_transaction
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelSubscriptionImportedEvent:
      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:
            omnichannel_subscription_item:
              $ref: "#/components/schemas/OmnichannelSubscriptionItem"
            omnichannel_subscription:
              $ref: "#/components/schemas/OmnichannelSubscription"
            omnichannel_transaction:
              $ref: "#/components/schemas/OmnichannelTransaction"
            omnichannel_subscription_item_scheduled_change:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemScheduledChange"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_subscription
          - omnichannel_subscription_item
          - omnichannel_subscription_item_scheduled_change
          - omnichannel_transaction
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelSubscriptionItem:
      type: object
      description: "Represents a product entitlement (item) within an [`omnichannel_subscription`](/docs/api/omnichannel_subscriptions)\
        \ purchased on Apple App Store or Google Play Store.\n\nStatus, auto-renew,\
        \ term dates, and cancel/expire reasons live on this resource. See [omnichannel\
        \ statuses](/docs/api/omnichannel_statuses) for store mappings.\n\nWhen `has_scheduled_changes`\
        \ is `true`, use [List scheduled changes](/docs/api/omnichannel_subscription_items/list-scheduled-changes-for-omnichannel-subscription-item)\
        \ to retrieve deferred product or pause changes.  \n**Note:**\nThis resource\
        \ represents in-app subscription items made on Apple App Store and Google\
        \ Play Store.\n"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Uniquely identifies an `omnichannel_subscription_item`.
          maxLength: 40
          example: null
        item_id_at_source:
          type: string
          deprecated: false
          description: |
            Product identifier of this subscription item in the source store.

            **Apple App Store**: The App Store Connect product identifier.

            **Google Play Store** : The Google Play product / base-plan identifier associated with the active entitlement. See also `item_parent_id_at_source` when a parent/child hierarchy applies.
          maxLength: 100
          example: null
        item_parent_id_at_source:
          type: string
          deprecated: false
          description: |
            Parent product identifier in the source store, when the store exposes a parent/child product hierarchy.

            **Apple App Store**: Typically the subscription group / parent product context when applicable.

            **Google Play Store**: Typically the parent product ID associated with the base plan / offer hierarchy when applicable.
          maxLength: 100
          example: null
        status:
          type: string
          deprecated: false
          description: |
            Status of the `omnichannel_subscription_item`. Status lives on the item, not on the parent subscription.
            [Learn more](/docs/api/omnichannel_statuses) about status and store mappings.

            * in_grace_period - Billing is retrying during a grace period; service should typically continue.
            * in_dunning - Billing is retrying after a payment failure and access may be restricted (Apple billing retry / Google account hold).
            * expired - The subscription item expired for a non-cancellation reason. See `expiration_reason`.
            * active -
              The subscription item is active and entitled for the current term.

              **Google Play Store** : Also used when Google has canceled auto-renew but the term has not ended (`auto_renew_status` = `off`).
            * cancelled - The subscription item is cancelled (entitlement ended due to cancellation / revoke / refund contexts). See `cancellation_reason`.
            * paused - The subscription item is paused. See `resumes_at` when available.
          enum:
          - active
          - expired
          - cancelled
          - in_dunning
          - in_grace_period
          - paused
          example: null
        auto_renew_status:
          type: string
          deprecated: false
          description: |
            Whether the subscription item is set to auto-renew at the end of the current term (`on` or `off`).

            **Google Play Store** : When the customer cancels but remains in-term, `status` stays `active` and `auto_renew_status` is `off`.

            * on - Auto-renewal is enabled for the `omnichannel_subscription_item`.
            * off - Auto-renewal is disabled for the `omnichannel_subscription_item`.
          enum:
          - "off"
          - "on"
          example: null
        current_term_start:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Start of the current billing period of the subscription item. Applicable when `status` is `active`.
          example: null
        current_term_end:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            End of the current billing period of the subscription item. Applicable when [`status`](/docs/api/omnichannel_subscription_items/omnichannel_subscription_item-object#status) is `active`.

            **Apple App Store** : Closest analogue to [`next_billing_at`](/docs/api/subscriptions/subscription-object#next_billing_at) because Apple does not expose a separate next-renewal timestamp. Apple may renew up to 24 hours before expiry and, in billing retry, may retry for up to 60 days. [Learn more](https://developer.apple.com/documentation/storekit/in-app_purchase/original_api_for_in-app_purchase/subscriptions_and_offers/handling_subscriptions_billing#3221910).

            **Google Play Store** : Corresponds to the subscription expiry / next billing boundary from Play. When the customer has canceled but the term has not ended, `status` remains `active` with `auto_renew_status` = `off` (see [omnichannel statuses](/docs/api/omnichannel_statuses)).
          example: null
        expired_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp when the subscription associated with the `omnichannel_subscription_item` expired in the `source`.
          example: null
        expiration_reason:
          type: string
          deprecated: false
          description: |
            Specifies the reason for the subscription expiration. Present when `status` is `expired`.

            **Apple App Store** : Commonly maps from Apple expiration intents such as `BILLING_ERROR`, `PRODUCT_NOT_AVAILABLE`, and `OTHER`.

            **Google Play Store** : User-initiated and merchant-revoked expirations typically map to `cancelled` with a `cancellation_reason` instead of `expired`.

            * other -
              The subscription associated with the item expired for an unspecified reason.

              **Apple App Store** : Maps from expiration intent `OTHER`.
            * product_not_available -
              The product was unavailable for purchase at the time of renewal.

              **Apple App Store** : Maps from expiration intent `PRODUCT_NOT_AVAILABLE`.
            * billing_error -
              Billing error, such as invalid customer payment information.

              **Apple App Store** : Maps from expiration intent `BILLING_ERROR`.
          enum:
          - billing_error
          - product_not_available
          - other
          - subscription_not_found_in_source
          example: null
        cancelled_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp when the subscription associated with the `omnichannel_subscription_item` was cancelled in the `source`.
          example: null
        cancellation_reason:
          type: string
          deprecated: false
          description: |
            The reason the subscription item was cancelled. Present when `status` is `cancelled`. Store applicability varies by enum value.

            * refunded_for_other_reason -
              The subscription was cancelled and refunded for another reason.

              **Apple App Store**: Commonly set for refund notifications with a non-app-issue refund reason.

              **Google Play Store**: Not typically used for this reason code.
            * refunded_due_to_app_issue -
              The subscription was cancelled and refunded due to an app issue.

              **Apple App Store**: Commonly set for refund notifications with an app-issue refund reason.

              **Google Play Store**: Not typically used for this reason code.
            * customer_did_not_consent_to_price_increase -
              The customer did not consent to a price increase for the subscription item.

              **Apple App Store** : Maps from expiration intent `CUSTOMER_DID_NOT_CONSENT_TO_PRICE_INCREASE`.

              **Google Play Store**: Not typically used for this reason code.
            * customer_cancelled -
              The customer voluntarily cancelled the subscription.

              **Apple App Store** : Commonly maps from expiration intent `CUSTOMER_CANCELLED`.

              **Google Play Store**: Commonly maps from user-initiated cancellation / cancel-at-term-end flows.
            * merchant_revoked -
              The merchant revoked access to the subscription.

              **Apple App Store** : Can apply when access is revoked (for example, `REVOKED` / related refund revoke flows).

              **Google Play Store** : Commonly maps from revoke / chargeback-style contexts (for example, `SUBSCRIPTION_REVOKED`).
          enum:
          - customer_cancelled
          - customer_did_not_consent_to_price_increase
          - refunded_due_to_app_issue
          - refunded_for_other_reason
          - merchant_revoked
          example: null
        grace_period_expires_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp when the grace period for the `omnichannel_subscription_item` expires in the `source`.

            **Apple App Store** : Present when the item is in `in_grace_period` (Apple billing grace period).

            **Google Play Store** : Present when the item is in `in_grace_period` (`SUBSCRIPTION_STATE_IN_GRACE_PERIOD`).
          example: null
        resumes_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp when the subscription automatically resumes after being set to `paused`.

            **Google Play Store**: Typically present for paused subscriptions.

            **Apple App Store**: Pause is not generally applicable in the same way; this attribute is usually absent.
          example: null
        has_scheduled_changes:
          type: boolean
          default: false
          deprecated: false
          description: |
            Indicates whether the `omnichannel_subscription_item` has any scheduled changes. When `true`, use [List scheduled changes for an omnichannel subscription item](/docs/api/omnichannel_subscription_items/list-scheduled-changes-for-omnichannel-subscription-item) to retrieve them.
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp when the `omnichannel_subscription_item` was last updated in Chargebee.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            Version number of this resource. The `resource_version`
            is updated with a new timestamp in milliseconds for every change made to the resource.
          example: null
        omnichannel_subscription_item_offers:
          type: array
          deprecated: false
          description: |
            Represents the `omnichannel_subscription_item_offers`
            associated with the `omnichannel_subscription_item`.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  Unique identifier for the `omnichannel_subscription_item_offer`.
                  System-generated.
                maxLength: 40
                example: null
              offer_id_at_source:
                type: string
                deprecated: false
                description: |
                  Identifier of the offer on the source platform (for example, Apple App Store or Google Play Store). Used to map Chargebee's record to the source.

                  **Apple App Store**: Offer identifier from App Store Connect / StoreKit.

                  **Google Play Store**: Offer / base-plan offer identifier from Play Console when applicable.
                maxLength: 100
                example: null
              category:
                type: string
                deprecated: false
                description: |
                  Indicates functional purpose of the offer. For example, `introductory`
                  indicates a first-time offer for new subscribers.

                  * developer_determined -
                    Offer terms are determined by the developer and may include unique pricing or features.
                    **Note**: Support for this category is planned for a future update.
                  * promotional - Promotional offer that may be available to both new and existing subscribers, often featuring limited-time pricing or terms.
                  * introductory - Introductory offer for first-time subscribers, typically providing special pricing or terms for the first billing cycle.
                enum:
                - introductory
                - promotional
                - developer_determined
                example: null
              category_at_source:
                type: string
                deprecated: false
                description: |
                  Category label as defined by the source platform (for example, Apple App Store or Google Play Store). Directly fetched from the source; useful for debugging or platform-specific workflows.
                maxLength: 100
                example: null
              type:
                type: string
                deprecated: false
                description: |
                  Indicates how the offer is applied from a pricing-model perspective.

                  * pay_as_you_go - Applies a recurring discounted price at each billing cycle over multiple renewals, such as on a monthly plan, a discount on the initial purchase, and the next three billing cycles.
                  * free_trial - Provides a free trial period. The customer is not charged during the trial; regular billing begins after the trial ends.
                  * pay_up_front - Requires a fixed upfront payment for a defined subscription period, often at a discount. For example, pay for two months in advance.
                enum:
                - free_trial
                - pay_up_front
                - pay_as_you_go
                example: null
              type_at_source:
                type: string
                deprecated: false
                description: |
                  Offer type as recorded by the source platform (for example, Apple App Store or Google Play Store). Like `category_at_source`, this is useful for tracking and audit.
                maxLength: 100
                example: null
              discount_type:
                type: string
                deprecated: false
                description: |
                  Discount strategy: percentage discount, fixed amount off, or fixed price override.

                  * fixed_amount - Discount that subtracts a fixed amount from the original price of the subscription item.
                  * percentage - Applies a percentage discount on the original price of the subscription item. For example, 20% off.
                  * price - Overrides the original price with a fixed discounted price for the offer term. For example, set the price to $9.99 during the offer.
                enum:
                - fixed_amount
                - percentage
                - price
                example: null
              duration:
                type: string
                deprecated: false
                description: |
                  Indicates how long the offer applies to the subscription. This attribute uses ISO 8601 duration format. For example, `P1M`
                  (1 month), `P7D`
                  (7 days). After this duration, regular pricing resumes.
                maxLength: 5
                example: null
              percentage:
                type: number
                format: double
                deprecated: false
                description: |
                  Used when `discount_type`
                  is `percentage`.
                  Specifies the discount as a decimal value. For example, a value of 12.5 corresponds to a 12.5% discount.
                maximum: 100
                minimum: 0.01
                example: null
              price_currency:
                type: string
                deprecated: false
                description: |
                  Three-letter [ISO 4217](https://www.chargebee.com/docs/billing/2.0/site-configuration/supported-currencies)
                  currency code for the offer price (for example, USD, EUR, INR).
                maxLength: 3
                example: null
              price_units:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Whole-unit portion of the offer amount (for example, `10` for $10.00).
                  **Note:** Depending on the discount type, this value can represent different meanings. For a `fixed_amount` discount, it indicates the amount deducted from the original price; for a `price` discount, it reflects the final amount payable by the customer.
                example: null
              price_nanos:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Fractional part of the offer amount, expressed in nanos (billionths of the currency unit). For example, `500000000` represents 0.50. Combine with `price_units` to determine the total price (for example, $10.50).
                  **Note:** Depending on the discount type, this value can represent different meanings. For a `fixed_amount` discount, it indicates the amount deducted from the original price; for a `price` discount, it reflects the final amount payable by the customer.
                example: null
              offer_term_start:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Timestamp when the offer becomes effective for the subscription item. It is typically set to the time when the offer is first applied or activated.
                example: null
              offer_term_end:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Timestamp when the offer becomes invalid. After this time, regular pricing or terms apply to the subscription item.
                example: null
              resource_version:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Version number of this resource. The `resource_version`
                  is updated with a new timestamp in milliseconds for every change made to the resource.
                example: null
            required:
            - category
            - duration
            - id
            - type
            example: null
          example: null
        upcoming_renewal:
          type: object
          deprecated: false
          description: |
            Information about the upcoming renewal price.

            **Google Play Store** : Present when Google provides renewal price information and [`auto_renew_status`](/docs/api/omnichannel_subscription_items/omnichannel_subscription_item-object#auto_renew_status) is `on`.

            **Apple App Store**: Not applicable; this field is absent.
          properties:
            price_currency:
              type: string
              deprecated: false
              description: |
                The three-letter [ISO 4217](https://www.chargebee.com/docs/supported-currencies.html) currency code in which the next renewal is set to occur (`price_currency`).
              maxLength: 3
              example: null
            price_units:
              type: integer
              format: int64
              deprecated: false
              description: |
                The whole units of the amount.
                For example:
                if `price_currency` is **USD** (two-decimal currency), then the unit value for **USD** **1.23** will be **1**
                if `price_currency` is **JPY** (zero-decimal currency), then the unit value for **JPY** **123** will be **123**
                if `price_currency` is **BHD** (three-decimal currency), then the unit value for **BHD** **1.234** will be **1**
              example: null
            price_nanos:
              type: integer
              format: int64
              deprecated: false
              description: |
                The fractional price amount, in nanos (billionths of the currency unit), for the next renewal.
                The value must be between **0** and **+999,999,999** inclusive.
                For example:
                If `price_currency` is **USD** (two-decimal currency), then nanos value for **USD** **1.23** will be **230,000,000**
                If `price_currency` is **JPY** (zero-decimal currency), then nanos value for **JPY** **123** will be **0**
                If `price_currency` is **BHD** (three-decimal currency), then nanos value for **BHD** **1.234** will be **234,000,000**
              example: null
          example: null
        linked_item:
          type: object
          deprecated: false
          description: |
            Represents an active product catalog mapping between an `omnichannel_subscription_item`
            and a Chargebee `item`.
            Use this attribute to retrieve entitlements for the `omnichannel_subscription_item`
            that are associated with the linked Chargebee `item`.
          properties:
            id:
              type: string
              deprecated: false
              description: |
                Represents the `item_id`
                of the Chargebee item linked to the `omnichannel_subscription_item`.
              maxLength: 100
              example: null
            linked_at:
              type: integer
              format: unix-time
              deprecated: false
              description: |
                Timestamp when the mapping between the `omnichannel_subscription_item`
                and the Chargebee `item` was created in Chargebee.
              example: null
          required:
          - id
          example: null
      required:
      - has_scheduled_changes
      - id
      - item_id_at_source
      - status
      - updated_at
      example: null
    OmnichannelSubscriptionItemCancellationScheduledEvent:
      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:
            omnichannel_subscription:
              $ref: "#/components/schemas/OmnichannelSubscription"
            omnichannel_subscription_item:
              $ref: "#/components/schemas/OmnichannelSubscriptionItem"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_subscription
          - omnichannel_subscription_item
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelSubscriptionItemCancelledEvent:
      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:
            omnichannel_subscription:
              $ref: "#/components/schemas/OmnichannelSubscription"
            omnichannel_subscription_item:
              $ref: "#/components/schemas/OmnichannelSubscriptionItem"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_subscription
          - omnichannel_subscription_item
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelSubscriptionItemChangeScheduledEvent:
      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:
            omnichannel_subscription_item:
              $ref: "#/components/schemas/OmnichannelSubscriptionItem"
            omnichannel_subscription_item_scheduled_change:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemScheduledChange"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_subscription_item
          - omnichannel_subscription_item_scheduled_change
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelSubscriptionItemChangedEvent:
      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:
            omnichannel_subscription_item:
              $ref: "#/components/schemas/OmnichannelSubscriptionItem"
            omnichannel_subscription:
              $ref: "#/components/schemas/OmnichannelSubscription"
            omnichannel_transaction:
              $ref: "#/components/schemas/OmnichannelTransaction"
            omnichannel_subscription_item_scheduled_change:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemScheduledChange"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_subscription
          - omnichannel_subscription_item
          - omnichannel_subscription_item_scheduled_change
          - omnichannel_transaction
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelSubscriptionItemDowngradeScheduledEvent:
      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:
            omnichannel_subscription:
              $ref: "#/components/schemas/OmnichannelSubscription"
            omnichannel_subscription_item:
              $ref: "#/components/schemas/OmnichannelSubscriptionItem"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_subscription
          - omnichannel_subscription_item
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelSubscriptionItemDowngradedEvent:
      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:
            omnichannel_subscription_item:
              $ref: "#/components/schemas/OmnichannelSubscriptionItem"
            omnichannel_subscription:
              $ref: "#/components/schemas/OmnichannelSubscription"
            omnichannel_transaction:
              $ref: "#/components/schemas/OmnichannelTransaction"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_subscription
          - omnichannel_subscription_item
          - omnichannel_transaction
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelSubscriptionItemDunningExpiredEvent:
      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:
            omnichannel_subscription:
              $ref: "#/components/schemas/OmnichannelSubscription"
            omnichannel_subscription_item:
              $ref: "#/components/schemas/OmnichannelSubscriptionItem"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_subscription
          - omnichannel_subscription_item
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelSubscriptionItemDunningStartedEvent:
      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:
            omnichannel_subscription:
              $ref: "#/components/schemas/OmnichannelSubscription"
            omnichannel_subscription_item:
              $ref: "#/components/schemas/OmnichannelSubscriptionItem"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_subscription
          - omnichannel_subscription_item
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelSubscriptionItemExpiredEvent:
      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:
            omnichannel_subscription:
              $ref: "#/components/schemas/OmnichannelSubscription"
            omnichannel_subscription_item:
              $ref: "#/components/schemas/OmnichannelSubscriptionItem"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_subscription
          - omnichannel_subscription_item
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelSubscriptionItemGracePeriodExpiredEvent:
      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:
            omnichannel_subscription:
              $ref: "#/components/schemas/OmnichannelSubscription"
            omnichannel_subscription_item:
              $ref: "#/components/schemas/OmnichannelSubscriptionItem"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_subscription
          - omnichannel_subscription_item
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelSubscriptionItemGracePeriodStartedEvent:
      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:
            omnichannel_subscription:
              $ref: "#/components/schemas/OmnichannelSubscription"
            omnichannel_subscription_item:
              $ref: "#/components/schemas/OmnichannelSubscriptionItem"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_subscription
          - omnichannel_subscription_item
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelSubscriptionItemMetric:
      type: object
      description: |
        This resource represents the revenue metrics, such as MRR, computed for an [Omnichannel subscription item](/docs/api/omnichannel_subscription_items).

        This resource is available only with [Product Catalog 2.0](https://www.chargebee.com/docs/2.0/product-catalog.html) and the Omnichannel Subscriptions feature. It is not available through any standalone API operation; it is returned only in the [`omnichannel_subscription_item_mrr_updated`](/docs/api/events/webhook/omnichannel_subscription_item_mrr_updated) webhook event payload.

        The event `content` includes the related [`omnichannel_subscription`](/docs/api/omnichannel_subscriptions), [`omnichannel_subscription_item`](/docs/api/omnichannel_subscription_items), and `omnichannel_subscription_item_metric`.
      properties:
        customer_id:
          type: string
          deprecated: false
          description: |
            The `id` of the [customer](/docs/api/customers/customer-object#id) object
            associated with this metric.
          maxLength: 100
          example: null
        omnichannel_subscription_id:
          type: string
          deprecated: false
          description: |
            The `id`
            of the [omnichannel_subscription](/docs/api/omnichannel_subscriptions/omnichannel_subscription-object)
            associated with this metric.
          maxLength: 100
          example: null
        omnichannel_subscription_item_id:
          type: string
          deprecated: false
          description: |
            The `id`
            of the [omnichannel_subscription_item](/docs/api/omnichannel_subscription_items/omnichannel_subscription_item-object)
            associated with this metric.
          maxLength: 100
          example: null
        item_id_at_source:
          type: string
          deprecated: false
          description: |
            Product identifier of the subscription item in the [`source`](/docs/api/omnichannel_subscriptions/omnichannel_subscription-object#source) store.

            **Apple App Store**: The App Store Connect product identifier.

            **Google Play Store**: The Google Play product / base-plan identifier associated with the active entitlement.
          maxLength: 100
          example: null
        mrr_currency:
          type: string
          deprecated: false
          description: |
            The three-letter [ISO 4217](https://www.chargebee.com/docs/supported-currencies.html) currency code in which the MRR is calculated. May be absent when the MRR is unavailable.
          maxLength: 3
          example: null
        mrr_units:
          type: integer
          format: int64
          deprecated: false
          description: |
            The whole-unit portion of the calculated MRR amount. Defaults to **0** when the MRR is zero or unavailable.
            For example:
            if `mrr_currency` is **USD** (i.e. two decimal currency), then the unit value for **USD** **1.23** will be **1**
            if `mrr_currency` is **JPY** (i.e. zero decimal currency), then the unit value for **JPY** **123** will be **123**
          example: null
        mrr_nanos:
          type: integer
          format: int64
          deprecated: false
          description: |
            The fractional portion of the calculated MRR amount, in nanos (billionths of the currency unit). Defaults to **0** when the MRR is zero or unavailable.
            The value must be between **0** and **+999,999,999** inclusive.
            For example:
            if `mrr_currency` is **USD** (i.e. two decimal currency), then the nanos value for **USD** **1.23** will be **230,000,000**
            if `mrr_currency` is **JPY** (i.e. zero decimal currency), then the nanos value for **JPY** **123** will be **0**
          example: null
        effective_from:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp from which this metric value is effective.
          example: null
        calculated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The time at which Chargebee computed this metric value.
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Indicates timestamp when the `omnichannel_subscription_item_metric`
            was created in Chargebee.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            Version number of this immutable metric snapshot, as a timestamp in milliseconds.
            Each [`omnichannel_subscription_item_mrr_updated`](/docs/api/events/webhook/omnichannel_subscription_item_mrr_updated) event delivers a new snapshot (for example after a renewal, price or offer change, or a status transition that affects revenue); earlier snapshots are not mutated.
          example: null
      required:
      - created_at
      - effective_from
      - item_id_at_source
      example: null
    OmnichannelSubscriptionItemMrrUpdatedEvent:
      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:
            omnichannel_subscription_item:
              $ref: "#/components/schemas/OmnichannelSubscriptionItem"
            omnichannel_subscription:
              $ref: "#/components/schemas/OmnichannelSubscription"
            omnichannel_subscription_item_metric:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemMetric"
          required:
          - omnichannel_subscription
          - omnichannel_subscription_item
          - omnichannel_subscription_item_metric
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      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
    OmnichannelSubscriptionItemPauseScheduledEvent:
      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:
            omnichannel_subscription_item:
              $ref: "#/components/schemas/OmnichannelSubscriptionItem"
            omnichannel_subscription_item_scheduled_change:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemScheduledChange"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_subscription_item
          - omnichannel_subscription_item_scheduled_change
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelSubscriptionItemPausedEvent:
      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:
            omnichannel_subscription:
              $ref: "#/components/schemas/OmnichannelSubscription"
            omnichannel_subscription_item:
              $ref: "#/components/schemas/OmnichannelSubscriptionItem"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_subscription
          - omnichannel_subscription_item
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelSubscriptionItemReactivatedEvent:
      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:
            omnichannel_subscription:
              $ref: "#/components/schemas/OmnichannelSubscription"
            omnichannel_subscription_item:
              $ref: "#/components/schemas/OmnichannelSubscriptionItem"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_subscription
          - omnichannel_subscription_item
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelSubscriptionItemRecoveredEvent:
      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:
            omnichannel_subscription_item:
              $ref: "#/components/schemas/OmnichannelSubscriptionItem"
            omnichannel_subscription:
              $ref: "#/components/schemas/OmnichannelSubscription"
            omnichannel_transaction:
              $ref: "#/components/schemas/OmnichannelTransaction"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_subscription
          - omnichannel_subscription_item
          - omnichannel_transaction
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelSubscriptionItemRenewedEvent:
      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:
            omnichannel_subscription_item:
              $ref: "#/components/schemas/OmnichannelSubscriptionItem"
            omnichannel_subscription:
              $ref: "#/components/schemas/OmnichannelSubscription"
            omnichannel_transaction:
              $ref: "#/components/schemas/OmnichannelTransaction"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_subscription
          - omnichannel_subscription_item
          - omnichannel_transaction
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelSubscriptionItemResubscribedEvent:
      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:
            omnichannel_subscription_item:
              $ref: "#/components/schemas/OmnichannelSubscriptionItem"
            omnichannel_subscription:
              $ref: "#/components/schemas/OmnichannelSubscription"
            omnichannel_transaction:
              $ref: "#/components/schemas/OmnichannelTransaction"
            omnichannel_subscription_item_scheduled_change:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemScheduledChange"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_subscription
          - omnichannel_subscription_item
          - omnichannel_subscription_item_scheduled_change
          - omnichannel_transaction
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelSubscriptionItemResumedEvent:
      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:
            omnichannel_subscription:
              $ref: "#/components/schemas/OmnichannelSubscription"
            omnichannel_subscription_item:
              $ref: "#/components/schemas/OmnichannelSubscriptionItem"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_subscription
          - omnichannel_subscription_item
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelSubscriptionItemScheduledCancellationRemovedEvent:
      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:
            omnichannel_subscription:
              $ref: "#/components/schemas/OmnichannelSubscription"
            omnichannel_subscription_item:
              $ref: "#/components/schemas/OmnichannelSubscriptionItem"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_subscription
          - omnichannel_subscription_item
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelSubscriptionItemScheduledChange:
      type: object
      description: |
        Represents a future change to an [`omnichannel_subscription_item`](/docs/api/omnichannel_subscription_items) that the store will apply later (typically at the end of the current term).

        **Apple App Store** : Created when the customer schedules a **downgrade** within the same subscription group (`DID_CHANGE_RENEWAL_PREF` / `DOWNGRADE`). `change_type` is typically `downgrade`. Upgrades apply immediately and do **not** create this resource.

        **Google Play Store** : Created when a product change uses the **`DEFERRED`** replacement mode (applied at term end). Immediate changes use `CHARGE_PRORATED_PRICE` and do **not** create this resource. A `change_type` of `pause` may appear for scheduled pause flows; confirm mapping against [omnichannel events](/docs/api/omnichannel_events).

        Retrieve scheduled changes with [List scheduled changes for an omnichannel subscription item](/docs/api/omnichannel_subscription_items/list-scheduled-changes-for-omnichannel-subscription-item) when [`has_scheduled_changes`](/docs/api/omnichannel_subscription_items/omnichannel_subscription_item-object#has_scheduled_changes) is `true`.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            Uniquely identifies an `omnichannel_subscription_item_scheduled_change`.
          maxLength: 40
          example: null
        omnichannel_subscription_item_id:
          type: string
          deprecated: false
          description: |
            The `id`
            of the [omnichannel subscription item](/docs/api/omnichannel_subscription_items/omnichannel_subscription_item-object#id)
            associated with this scheduled change.
          maxLength: 100
          example: null
        scheduled_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp when the scheduled change is expected to take effect (typically at the end of the current term).
          example: null
        change_type:
          type: string
          deprecated: false
          description: |
            Indicates the type of scheduled change.

            **Apple App Store** : Scheduled product downgrades typically use `downgrade`.

            **Google Play Store** : Deferred product replacements (`DEFERRED` replacement mode) are represented here. Immediate prorated replacements do not create this resource.

            See also [omnichannel events](/docs/api/omnichannel_events) for store notification mappings.

            * pause -
              A scheduled pause of the subscription item, applied later (usually at term end).

              **Google Play Store**: May correspond to a pause that is scheduled rather than applied immediately (for example, pause-schedule notifications). Confirm store mapping with your Chargebee omnichannel configuration.

              **Apple App Store**: Pause scheduling is generally not applicable in the same way.
            * downgrade -
              A scheduled product change to a different (typically lower) product / plan, applied later (usually at term end).

              **Apple App Store** : Created for scheduled downgrades (`DID_CHANGE_RENEWAL_PREF` / `DOWNGRADE`).

              **Google Play Store** : Used for deferred product changes (`DEFERRED` replacement mode). Confirm with your integration whether all deferred replacements use this enum or only true downgrades.
          enum:
          - downgrade
          - pause
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp when the `omnichannel_subscription_item_scheduled_change` was created in Chargebee.
          example: null
        modified_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp when the `omnichannel_subscription_item_scheduled_change` was last modified in Chargebee.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            Version number of this resource. The `resource_version`
            is updated with a new timestamp in milliseconds for every change made to the resource.
          example: null
        current_state:
          type: object
          deprecated: false
          description: |
            Snapshot of relevant item attributes before the scheduled change takes effect.
          properties:
            item_id_at_source:
              type: string
              deprecated: false
              description: |
                Current product identifier at the source before the change applies.

                **Apple App Store**: Current App Store Connect product ID.

                **Google Play Store**: Current Google Play product / base-plan identifier.

                Typically present when `change_type` is `downgrade` (or another product-changing scheduled change).
              maxLength: 100
              example: null
          example: null
        scheduled_state:
          type: object
          deprecated: false
          description: |
            Snapshot of the attributes that will apply after the scheduled change takes effect.
          properties:
            item_id_at_source:
              type: string
              deprecated: false
              description: |
                Target product identifier at the source after the change applies.

                **Apple App Store**: Target App Store Connect product ID for the scheduled downgrade.

                **Google Play Store**: Target Google Play product / base-plan identifier for the deferred change.

                Typically present when `change_type` is `downgrade` (or another product-changing scheduled change).
              maxLength: 100
              example: null
          example: null
      required:
      - change_type
      - created_at
      - modified_at
      - scheduled_at
      example: null
    OmnichannelSubscriptionItemScheduledChangeRemovedEvent:
      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:
            omnichannel_subscription_item:
              $ref: "#/components/schemas/OmnichannelSubscriptionItem"
            omnichannel_subscription_item_scheduled_change:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemScheduledChange"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_subscription_item
          - omnichannel_subscription_item_scheduled_change
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelSubscriptionItemScheduledDowngradeRemovedEvent:
      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:
            omnichannel_subscription:
              $ref: "#/components/schemas/OmnichannelSubscription"
            omnichannel_subscription_item:
              $ref: "#/components/schemas/OmnichannelSubscriptionItem"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_subscription
          - omnichannel_subscription_item
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelSubscriptionItemUpdatedEvent:
      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:
            omnichannel_subscription_item:
              $ref: "#/components/schemas/OmnichannelSubscriptionItem"
            omnichannel_subscription:
              $ref: "#/components/schemas/OmnichannelSubscription"
            omnichannel_transaction:
              $ref: "#/components/schemas/OmnichannelTransaction"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_subscription
          - omnichannel_subscription_item
          - omnichannel_transaction
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelSubscriptionItemUpgradedEvent:
      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:
            omnichannel_subscription_item:
              $ref: "#/components/schemas/OmnichannelSubscriptionItem"
            omnichannel_subscription:
              $ref: "#/components/schemas/OmnichannelSubscription"
            omnichannel_transaction:
              $ref: "#/components/schemas/OmnichannelTransaction"
            omnichannel_subscription_item_scheduled_change:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemScheduledChange"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_subscription
          - omnichannel_subscription_item
          - omnichannel_subscription_item_scheduled_change
          - omnichannel_transaction
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelSubscriptionMovedInEvent:
      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:
            omnichannel_subscription:
              $ref: "#/components/schemas/OmnichannelSubscription"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - omnichannel_subscription
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    OmnichannelTransaction:
      type: object
      description: "A unified representation of a store purchase or renewal transaction\
        \ across Apple App Store and Google Play Store.\n\nUse `id_at_source` to correlate\
        \ with the store-native transaction identifier:\n\n* **Apple App Store** :\
        \ App Store **Transaction ID**\n* **Google Play Store** : Google Play **Order\
        \ ID** (`GPA....`)\n\nParent subscription / one-time-order resources use purchase-token\
        \ semantics for Google `id_at_source`; do not treat those as interchangeable\
        \ with this transaction Order ID.\n\n### Apple App Store\n\nThe [price](https://developer.apple.com/documentation/appstoreservernotifications/price)\
        \ value reflects the price you configured in App Store Connect, which the\
        \ system records at the time of transaction ([transacted_at](/docs/api/omnichannel_transactions/omnichannel_transaction-object#transacted_at))\
        \ after the discount if any offers are applied.  \n**Important**\nFor financial\
        \ and accounting purposes, use the App Store Connect reporting tools. For\
        \ more information, see [Download financial reports](https://developer.apple.com/help/app-store-connect/getting-paid/download-financial-reports)\
        \ and [Overview of reporting tools](https://developer.apple.com/help/app-store-connect/measure-app-performance/overview-of-reporting-tools).\n\
        [Learn more](https://developer.apple.com/documentation/appstoreservernotifications/price)\
        \ about price in Apple App Store.\n\n### Google Play Store\n\nGoogle Play\
        \ does not always expose a complete transaction amount or purchase time for\
        \ every notification path. When Google provides price / time data for a transaction,\
        \ Chargebee records `price_*` and `transacted_at`; otherwise these attributes\
        \ may be absent. Some Google one-time-order samples include price and `transacted_at`\
        \ on `purchase_transaction`.\n\nTransactions can be linked to subscriptions\
        \ and/or one-time orders via `linked_omnichannel_subscriptions` and `linked_omnichannel_one_time_orders`.\
        \ Chargebee may also emit [`omnichannel_transaction_created`](/docs/api/events/webhook/omnichannel_transaction_created)\
        \ when a new transaction row is recorded.\n"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            The ID generated by Chargebee for the omnichannel transaction.
          maxLength: 40
          example: null
        id_at_source:
          type: string
          deprecated: false
          description: |
            The store-native identifier for this transaction.

            **Apple App Store** : The App Store **Transaction ID** for this purchase or renewal.

            **Google Play Store** : The Google Play **Order ID** (typically `GPA....`) --- not the subscription or one-time-order **purchase token** (those live on `omnichannel_subscription.id_at_source` / `omnichannel_one_time_order.id_at_source`).
          maxLength: 100
          example: null
        app_id:
          type: string
          deprecated: false
          description: |
            App Identifier in Chargebee. This is the handle created by Chargebee for your app. To get the `app_id`:

            * For **Apple** , follow [these steps](https://www.chargebee.com/docs/billing/2.0/mobile-subscriptions/omnichannel-app-store#create-an-omnichannel-subscription-for-in-app-purchases).
            * For **Google** , follow [these steps](https://www.chargebee.com/docs/billing/2.0/mobile-subscriptions/omnichannel-play-store#connect-google-app-to-chargebee-to-generate-unique-app-id-and-notifications-url).
          maxLength: 100
          example: null
        price_currency:
          type: string
          deprecated: false
          description: |
            The three-letter ISO 4217 currency code associated with the transaction (`price_currency`), when price data is available.
          maxLength: 3
          example: null
        price_units:
          type: integer
          format: int64
          deprecated: false
          description: |
            The whole units of the amount, when price data is available.
            For example:
            if `price_currency` is **USD** (two-decimal currency), then the unit value for **USD** **1.23** will be **1**
            if `price_currency` is **JPY** (zero-decimal currency), then the unit value for **JPY** **123** will be **123**
            if `price_currency` is **BHD** (three-decimal currency), then the unit value for **BHD** **1.234** will be **1**
          example: null
        price_nanos:
          type: integer
          format: int64
          deprecated: false
          description: |
            The fraction part of the amount, when price data is available.
            The value must be between **0** and **+999,999,999** inclusive.
            For example:
            If `price_currency` is **USD** (two-decimal currency), then nanos value for **USD** **1.23** will be **230,000,000**
            If `price_currency` is **JPY** (zero-decimal currency), then nanos value for **JPY** **123** will be **0**
            If `price_currency` is **BHD** (three-decimal currency), then nanos value for **BHD** **1.234** will be **234,000,000**
          example: null
        type:
          type: string
          deprecated: false
          description: |
            Type of omnichannel transaction. Applies to both subscription and one-time-order purchase flows.

            * renewal - Indicates a renewal transaction for a previously completed subscription purchase. Not used for one-time orders.
            * purchase - Indicates an initial purchase transaction (subscription or one-time order).
          enum:
          - purchase
          - renewal
          example: null
        transacted_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp when the transaction occurred in the store, when available.
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp when the omnichannel transaction was created in Chargebee.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            Version number of this resource. The `resource_version`
            is updated with a new timestamp in milliseconds for every change made to the resource.
          example: null
        linked_omnichannel_subscriptions:
          type: array
          deprecated: false
          description: |
            A list of `omnichannel_subscription` objects linked to this transaction.
          items:
            type: object
            deprecated: false
            properties:
              omnichannel_subscription_id:
                type: string
                deprecated: false
                description: |
                  The `id` of a linked [`omnichannel_subscription`](/docs/api/omnichannel_subscriptions/omnichannel_subscription-object#id).
                maxLength: 100
                example: null
            example: null
          example: null
        linked_omnichannel_one_time_orders:
          type: array
          deprecated: false
          description: |
            A list of `omnichannel_one_time_order` objects linked to this transaction.
          items:
            type: object
            deprecated: false
            properties:
              omnichannel_one_time_order_id:
                type: string
                deprecated: false
                description: |
                  The `id` of a linked [`omnichannel_one_time_order`](/docs/api/omnichannel_one_time_orders/omnichannel_one_time_order-object#id).
                maxLength: 100
                example: null
            example: null
          example: null
      required:
      - app_id
      - created_at
      - id
      - id_at_source
      - type
      example: null
    OmnichannelTransactionCreatedEvent:
      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:
            omnichannel_transaction:
              $ref: "#/components/schemas/OmnichannelTransaction"
          required:
          - omnichannel_transaction
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      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
    OperationType:
      type: string
      deprecated: false
      enum:
      - add
      - remove
      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: |
            Version number of this resource. The `resource_version`
            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.
          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 unique ID of the
            [business entity](/docs/api/advanced-features)
            of this subscription. This is always the same as the
            [business entity](/docs/api/subscriptions/subscription-object#customer_id)
            of the customer.
          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_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
                  * adhoc - Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case
                enum:
                - adhoc
                - plan_item_price
                - addon_item_price
                - charge_item_price
                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: |
                The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
                without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                as `AZ`
                (not `US-AZ`
                ). For Tamil Nadu (India), set as `TN`
                (not `IN-TN`
                ). For British Columbia (Canada), set as `BC`
                (not `CA-BC`
                ). For Dubai (UAE), set as `DU`
                (not `AE-DU`
                ).
              maxLength: 50
              example: null
            state:
              type: string
              deprecated: false
              description: |
                The state/province name.
              maxLength: 50
              example: null
            country:
              type: string
              deprecated: false
              description: "The billing address country of the customer. Must be one\
                \ of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                .\n\n**Note**:\nIf you enter an invalid country code, the system will\
                \ return an error.  \n**Brexit**\n\nIf you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                \ the Brexit configuration, then `XI` (the code for **United Kingdom\
                \ - Northern Ireland**) is available as an 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://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: |
                The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
                without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                as `AZ`
                (not `US-AZ`
                ). For Tamil Nadu (India), set as `TN`
                (not `IN-TN`
                ). For British Columbia (Canada), set as `BC`
                (not `CA-BC`
                ). For Dubai (UAE), set as `DU`
                (not `AE-DU`
                ).
              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 country of the customer. Must be one\
                \ of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                .\n\n**Note**:\nIf you enter an invalid country code, the system will\
                \ return an error.  \n**Brexit**\n\nIf you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                \ the Brexit configuration, then `XI` (the code for **United Kingdom\
                \ - Northern Ireland**) is available as an 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://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: |
                  Type of this discount line item

                  * prorated_credits - Represents the credit adjustment items in invoice. The 'coupon_id' attribute will be null in this case
                  * document_level_coupon -
                    Represents the 'Document' level coupons applied to this document. Further the 'coupon_id' attribute specifies the [coupon](/docs/api/coupons/coupon-object)
                    id this discount is based on
                  * custom_discount - Represents the discount applied on an resent order against the orginal order.
                  * promotional_credits - Represents the Promotional Credits item in invoice. The 'coupon_id' attribute will be null in this case
                  * item_level_coupon -
                    Represents the 'Item' level coupons applied to this invoice. Further the 'coupon_id' attribute specifies the [coupon](/docs/api/coupons/coupon-object)
                    id this discount is based on
                  * document_level_discount -
                    The deduction is due to a discount applied to the invoice `sub_total`.
                    The discount id is available as the `entity_id`.
                  * item_level_discount - The deduction is due to a discount applied to a line item of the invoice. The discount id is available as the `entity_id`.
                enum:
                - item_level_coupon
                - document_level_coupon
                - promotional_credits
                - prorated_credits
                - custom_discount
                - item_level_discount
                - document_level_discount
                example: null
              entity_id:
                type: string
                deprecated: false
                description: |
                  When the deduction is due to a `coupon`
                  or a [discount](/docs/api/getting-started)
                  , then this is the `id`
                  of the coupon or discount.
                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/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
    OverridesMetric:
      type: object
      properties:
        item_type:
          type: string
          deprecated: false
          enum:
          - plan
          - addon
          - charge
          example: null
        total_overridden_item_count:
          type: integer
          format: int64
          deprecated: false
          example: null
        total_overridden_count:
          type: integer
          format: int64
          deprecated: false
          example: null
        last_updated_at:
          type: integer
          format: int64
          deprecated: false
          example: null
      example: null
    PauseOption:
      type: string
      deprecated: false
      enum:
      - immediately
      - end_of_term
      - specific_date
      - billing_cycles
      example: null
    PaymentDueReminderEvent:
      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"
            invoice:
              $ref: "#/components/schemas/Invoice"
          required:
          - customer
          - invoice
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      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: |
        A `payment_intent` 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.

        #### Auto-expiry

        All `payment_intent`s with `status` as `inited`, `in_progress` or `authorized` become `expired` after an **hour** automatically.
      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

            * tamara - Payments made via Tamara.
            * alipay_hk - Payments made via Alipay HK.
            * apple_pay - apple_pay
            * netbanking_emandates - netbanking_emandates
            * venmo - Venmo
            * after_pay - Payments made via Afterpay
            * giropay - giropay
            * momo - Payments made via MoMo.
            * blik - Payments made via BLIK.
            * dana - Payments made via Dana.
            * paypal_express_checkout - paypal_express_checkout
            * touch_n_go - Payments made via Touch 'n Go.
            * pix - Pix
            * amazon_payments - amazon_payments
            * grab_pay - Payments made via GrabPay
            * card - card
            * affirm_pay - Payments made via Affirm Pay.
            * go_pay - Payments made via GoPay
            * google_pay - google_pay
            * cash_app_pay - Payments made via Cash App Pay.
            * ideal - ideal
            * nequi - Payments made via Nequi.
            * dotpay - dotpay
            * sofort - sofort
            * gcash - Payments made via GCash.
            * nupay - Payments made via NuPay.
            * faster_payments - Faster Payments
            * rakuten_pay - Payments made via Rakuten Pay.
            * qpay - Payments made via Qpay.
            * online_banking_poland - Online Banking Poland
            * klarna - Payments made via Klarna.
            * swish - Payments made via Swish
            * kbc_payment_button - KBC Payment Button
            * bancontact - bancontact
            * trustly - Trustly
            * fpx - Payments made via FPX.
            * paypay - PayPay
            * kakao_pay - Payments made via Kakao Pay.
            * boleto - boleto
            * revolut_pay - Payments made via Revolut Pay.
            * naver_pay - Payments made via Naver Pay.
            * electronic_payment_standard - Electronic Payment Standard
            * p24 - Payments made via Przelewy24 (P24).
            * thai_qr - Payments made via Thai QR.
            * pay_by_bank - Pay By Bank
            * payme - Payments made via PayMe
            * pay_co - Payments made via PayCo
            * ovo - Payments made via OVO.
            * pay_to - PayTo
            * alipay - Payments made via Alipay.
            * picpay - Payments made via PicPay.
            * sepa_instant_transfer - SEPA Instant Transfer
            * mercado_pago - Payments made via Mercado Pago.
            * direct_debit - direct_debit
            * klarna_pay_now - Klarna Pay Now
            * stablecoin - Payments made via Stablecoin.
            * upi - upi
            * south_korean_cards - Payments made via South Korean Cards
            * wero - Payments made via Wero.
            * payconiq_by_bancontact - Payments made via Payconiq by Bancontact.
            * twint - Payments made via Twint
            * wechat_pay - Payments made via WeChat 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
          - alipay_hk
          - paypay
          - gcash
          - south_korean_cards
          - paynow
          - bizum
          - promptpay
          - dana
          - touch_n_go
          - tamara
          - qpay
          - ovo
          - momo
          - mercado_pago
          - nequi
          - nupay
          - picpay
          - thai_qr
          - blik
          - fpx
          - wero
          - p24
          - affirm_pay
          - rakuten_pay
          example: null
        success_url:
          type: string
          deprecated: false
          description: |
            The URL the customer will be directed to once 3DS verification is successful. Applicable only when `payment_method_type`
            is `ideal`
            , `sofort`
            , `dotpay`
            or `giropay`
            .
          maxLength: 250
          example: null
        failure_url:
          type: string
          deprecated: false
          description: |
            The URL the customer will be directed to when 3DS verification fails. Applicable only when `payment_method_type`
            is `ideal`
            , `sofort`
            , `dotpay`
            or `giropay`
            .
          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: |
            Version number of this resource. The `resource_version`
            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.
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this payment intent was last updated.
          example: null
        payment_method_options:
          type: object
          additionalProperties: true
          deprecated: false
          description: |
            Options used to process the payment method. This attribute is omitted when no preference is stored.

            * `card`: Options for card payments.
              * `three_d_secure`: Options for 3DS authentication.
                * `challenge_preference`: The preferred 3DS flow. Applicable only when `payment_method_type` is `card` and 3DS is enabled for the gateway account. Supported for Stripe, Adyen, and BlueSnap; ignored for other gateways. The gateway or card issuer can override the preference.
                  * `no_preference`: Chargebee, the gateway, and the issuer decide the 3DS flow.
                  * `no_challenge`: A frictionless flow without a challenge is requested.
                  * `challenge`: A challenge flow is requested.
          example: null
        customer_id:
          type: string
          deprecated: false
          description: "The unique identifier of the customer for whom the `payment_intent`\
            \ will be created. If specified, the `payment_intent` will be used exclusively\
            \ for that customer. If not specified, the `payment_intent` won't be associated\
            \ with any customer and will be available for any customer.  \n**See also**\n\
            [Customer resource lookup and creation](/docs/api/payment_intents)\n"
          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 unique ID of the [business entity](/docs/api/advanced-features)
            of this `payment_intent`
          maxLength: 50
          example: null
        brand_id:
          type: string
          deprecated: false
          description: |
            The unique ID of the [brand](/docs/api/brands) this payment intent belongs to. Unless a brand was specified in the request, this is the brand of the customer the payment intent was created for.
          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

                * requires_challenge - The transaction has to go through 3DS Challenge flow and the customer needs to authenticate via 3DS 2.0
                * 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.
                * refused - 3DS verification attempt failed.
                * authorized - 3DS verification successfully completed.
                * pending_authorization - Waiting for the authorization.
                * requires_redirection - The transaction has to go through 3DS Redirection flow and the customer needs to authenticate via 3DS 1.0
              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

                * stablecoin - Payments made via Stablecoin.
                * venmo - Venmo
                * sofort - sofort
                * blik - Payments made via BLIK.
                * alipay - Payments made via Alipay.
                * paypal_express_checkout - paypal_express_checkout
                * giropay - giropay
                * dana - Payments made via Dana.
                * bancontact - bancontact
                * naver_pay - Payments made via Naver Pay.
                * kakao_pay - Payments made via Kakao Pay.
                * go_pay - Payments made via GoPay
                * card - card
                * faster_payments - Faster Payments
                * paypay - PayPay
                * south_korean_cards - Payments made via South Korean Cards
                * qpay - Payments made via Qpay.
                * kbc_payment_button - KBC Payment Button
                * nupay - Payments made via NuPay.
                * momo - Payments made via MoMo.
                * ideal - ideal
                * sepa_instant_transfer - SEPA Instant Transfer
                * gcash - Payments made via GCash.
                * nequi - Payments made via Nequi.
                * wero - Payments made via Wero.
                * pay_by_bank - Pay By Bank
                * klarna - Payments made via Klarna.
                * online_banking_poland - Online Banking Poland
                * p24 - Payments made via Przelewy24 (P24).
                * swish - Payments made via Swish
                * electronic_payment_standard - Electronic Payment Standard
                * boleto - boleto
                * wechat_pay - Payments made via WeChat Pay.
                * cash_app_pay - Payments made via Cash App Pay.
                * revolut_pay - Payments made via Revolut Pay.
                * rakuten_pay - Payments made via Rakuten Pay.
                * fpx - Payments made via FPX.
                * thai_qr - Payments made via Thai QR.
                * grab_pay - Payments made via GrabPay
                * trustly - Trustly
                * payme - Payments made via PayMe
                * alipay_hk - Payments made via Alipay HK.
                * touch_n_go - Payments made via Touch 'n Go.
                * upi - upi
                * amazon_payments - amazon_payments
                * direct_debit - direct_debit
                * after_pay - Payments made via Afterpay
                * mercado_pago - Payments made via Mercado Pago.
                * dotpay - dotpay
                * apple_pay - apple_pay
                * netbanking_emandates - netbanking_emandates
                * affirm_pay - Payments made via Affirm Pay.
                * klarna_pay_now - Klarna Pay Now
                * google_pay - google_pay
                * ovo - Payments made via OVO.
                * picpay - Payments made via PicPay.
                * payconiq_by_bancontact - Payments made via Payconiq by Bancontact.
                * pay_co - Payments made via PayCo
                * twint - Payments made via Twint
                * tamara - Payments made via Tamara.
                * pay_to - PayTo
                * pix - Pix
              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
              - alipay_hk
              - paypay
              - gcash
              - south_korean_cards
              - paynow
              - bizum
              - promptpay
              - dana
              - touch_n_go
              - tamara
              - qpay
              - ovo
              - momo
              - mercado_pago
              - nequi
              - nupay
              - picpay
              - thai_qr
              - blik
              - fpx
              - wero
              - p24
              - affirm_pay
              - rakuten_pay
              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: |
                Error code received from the payment gateway when the `payment_attempt`
                fails.
              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
            routing_rule_id:
              type: string
              deprecated: false
              description: "The ID of the [Advanced Routing Rule](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/advanced-routing-rules)\
                \ used to select the payment gateway for this payment attempt. The\
                \ value is `0` when the default routing configuration is used. This\
                \ attribute is not returned when no routing evaluation is available.\
                \  \n**Note:**\n\n* Applicable only when Advanced Routing Rules is\
                \ enabled.\n* Advanced Routing Rules 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"
              maxLength: 50
              example: null
            payment_method_display_rule_id:
              type: string
              deprecated: false
              description: "The ID of the [Payment Method Display Rule](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/payment-method-display-rules)\
                \ used to determine which payment methods are shown at checkout for\
                \ this payment attempt. The value is `0` when the default payment\
                \ method display configuration is used. This attribute is not returned\
                \ when no payment method display evaluation is available.  \n**Note:**\n\
                \n* Applicable only when Payment Method Display Rules is enabled.\n\
                * Payment Method Display Rules 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"
              maxLength: 50
              example: null
          required:
          - created_at
          - modified_at
          - status
          example: null
        payment_attempts:
          type: array
          deprecated: false
          description: |
            List of payment attempts associated with this PaymentIntent. Each item in the list is a `payment_attempt` object that shares the same structure as `active_payment_attempt`, except for the `routing_rule_id` and `payment_method_display_rule_id` attributes, which are returned only on `active_payment_attempt`.
          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: |
                  Current status of the payment attempt.

                  * requires_challenge - The transaction requires the 3DS Challenge flow, where the customer completes authentication through an inline 3DS 2.0 challenge presented by their card issuer.
                  * 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 must go through the 3DS Redirection flow, where the customer is redirected to their card issuer's authentication page (3DS 1.0) to verify the payment. After authentication, the customer is redirected to the specified [success_url](/docs/api/payment_intents/payment_intent-object#success_url)
                    or [failure_url](/docs/api/payment_intents/payment_intent-object#failure_url)
                    .
                  * inited - Payment attempt is initialized.
                  * authorized - 3DS verification successfully completed.
                  * pending_authorization - Waiting for the authorization.
                  * 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.

                  * swish - Payments made via Swish
                  * stablecoin - Payments made via Stablecoin.
                  * revolut_pay - Payments made via Revolut Pay.
                  * rakuten_pay - Payments made via Rakuten Pay.
                  * alipay - Payments made via Alipay.
                  * nupay - Payments made via NuPay.
                  * sofort - sofort
                  * giropay - giropay
                  * electronic_payment_standard - Electronic Payment Standard
                  * paypay - PayPay
                  * boleto - boleto
                  * kakao_pay - Payments made via Kakao Pay.
                  * pix - Pix
                  * kbc_payment_button - KBC Payment Button
                  * faster_payments - Faster Payments
                  * paypal_express_checkout - paypal_express_checkout
                  * go_pay - Payments made via GoPay
                  * ovo - Payments made via OVO.
                  * pay_by_bank - Pay By Bank
                  * klarna - Payments made via Klarna.
                  * after_pay - Payments made via Afterpay
                  * bancontact - bancontact
                  * trustly - Trustly
                  * wechat_pay - Payments made via WeChat Pay.
                  * twint - Payments made via Twint
                  * wero - Payments made via Wero.
                  * upi - upi
                  * cash_app_pay - Payments made via Cash App Pay.
                  * direct_debit - direct_debit
                  * thai_qr - Payments made via Thai QR.
                  * mercado_pago - Payments made via Mercado Pago.
                  * netbanking_emandates - netbanking_emandates
                  * amazon_payments - amazon_payments
                  * sepa_instant_transfer - SEPA Instant Transfer
                  * klarna_pay_now - Klarna Pay Now
                  * online_banking_poland - Online Banking Poland
                  * touch_n_go - Payments made via Touch 'n Go.
                  * fpx - Payments made via FPX.
                  * dotpay - dotpay
                  * google_pay - google_pay
                  * payconiq_by_bancontact - Payments made via Payconiq by Bancontact.
                  * payme - Payments made via PayMe
                  * card - card
                  * affirm_pay - Payments made via Affirm Pay.
                  * naver_pay - Payments made via Naver Pay.
                  * blik - Payments made via BLIK.
                  * nequi - Payments made via Nequi.
                  * dana - Payments made via Dana.
                  * alipay_hk - Payments made via Alipay HK.
                  * south_korean_cards - Payments made via South Korean Cards
                  * ideal - ideal
                  * p24 - Payments made via Przelewy24 (P24).
                  * grab_pay - Payments made via GrabPay
                  * pay_co - Payments made via PayCo
                  * picpay - Payments made via PicPay.
                  * momo - Payments made via MoMo.
                  * venmo - Venmo
                  * gcash - Payments made via GCash.
                  * apple_pay - apple_pay
                  * tamara - Payments made via Tamara.
                  * qpay - Payments made via Qpay.
                  * 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
                - alipay_hk
                - paypay
                - gcash
                - south_korean_cards
                - paynow
                - bizum
                - promptpay
                - dana
                - touch_n_go
                - tamara
                - qpay
                - ovo
                - momo
                - mercado_pago
                - nequi
                - nupay
                - picpay
                - thai_qr
                - blik
                - fpx
                - wero
                - p24
                - affirm_pay
                - rakuten_pay
                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
              routing_rule_id:
                type: string
                deprecated: false
                description: |
                  This attribute is not returned for historical payment attempts. See `active_payment_attempt.routing_rule_id`.
                maxLength: 50
                example: null
              payment_method_display_rule_id:
                type: string
                deprecated: false
                description: |
                  This attribute is not returned for historical payment attempts. See `active_payment_attempt.payment_method_display_rule_id`.
                maxLength: 50
                example: null
            required:
            - created_at
            - modified_at
            - status
            example: null
          example: null
        payment_intent_metadata:
          type: object
          deprecated: false
          description: |
            Details about the client and the request that Chargebee captured when the payment intent was confirmed.
          properties:
            source:
              type: string
              deprecated: false
              description: |
                The source of the request that confirmed the payment intent.

                * portal - The request came from the [Self-Serve Portal](https://www.chargebee.com/docs/billing/2.0/hosted-capabilities/self-serve-portal).
                * collect_now - The request came from the [Collect Now](https://apidocs.chargebee.com/docs/api/hosted_pages/collect-now) hosted page.
                * card_components - The request came from Chargebee.js [Card Components](https://www.chargebee.com/docs/payments/2.0/card-components-and-helpers/card-components).
                * checkout - The request came from [hosted checkout](https://www.chargebee.com/docs/billing/2.0/hosted-capabilities/hosted-checkout), including hosted checkout for [gift subscriptions](https://www.chargebee.com/docs/billing/2.0/subscriptions/gift-subscriptions#gift-subscription-workflow).
                * payment_components - The request came from Chargebee.js [Payment Components](https://www.chargebee.com/docs/payments/2.0/payment-components/overview).
                * payment_method_helper - The request came from the Chargebee.js [Payment Method Helper](https://www.chargebee.com/docs/payments/2.0/card-components-and-helpers/payment-method-helper).
              enum:
              - payment_method_helper
              - card_components
              - checkout
              - collect_now
              - portal
              - payment_components
              example: null
            client_ip_address:
              type: string
              deprecated: false
              description: |
                The IP address from which the payment intent was confirmed.
              maxLength: 50
              example: null
            user_agent:
              type: string
              deprecated: false
              description: |
                The [user agent string](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/User-Agent) of the client from which the payment intent was confirmed.
              maxLength: 1000
              example: null
            created_at:
              type: integer
              format: unix-time
              deprecated: false
              description: |
                Timestamp indicating when Chargebee captured this metadata.
              example: null
          required:
          - source
          example: null
      required:
      - amount
      - created_at
      - 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
      - tamara
      - qpay
      - blik
      - fpx
      - wero
      - p24
      - 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
      - alipay_hk
      - paypay
      - gcash
      - south_korean_cards
      - paynow
      - bizum
      - promptpay
      - dana
      - touch_n_go
      - ovo
      - momo
      - mercado_pago
      - nequi
      - nupay
      - picpay
      - thai_qr
      - affirm_pay
      - rakuten_pay
      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
      - alipay_hk
      - paypay
      - gcash
      - south_korean_cards
      - paynow
      - bizum
      - promptpay
      - dana
      - touch_n_go
      - tamara
      - qpay
      - ovo
      - momo
      - mercado_pago
      - nequi
      - nupay
      - picpay
      - thai_qr
      - blik
      - fpx
      - wero
      - p24
      - affirm_pay
      - rakuten_pay
      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: |
            The `id`
            of the `payment_reference_number`
            resource is a unique identifier assigned to the PRN to track and reference in systems.
          maxLength: 40
          example: null
        type:
          type: string
          deprecated: false
          description: |
            This attribute helps `type`
            field in the API, specifies how to reconcile offline payments, and generate `payment_reference_number`
            on invoices based on country-specific rules. Setting the `type`
            field generates `payment_reference_number`
            for the respective country and includes them on the invoice for correct reconciliation.

            * frn - The reference number printed on invoices in Finland is utilized by buyers for payment via bank transfer, facilitating the association of payments with invoices.
            * fik - Denmark based number calculated using recursive MOD 10 algorithm.
            * kid - The KID number (kundeidentifikasjon) in Norway is an abbreviation for "Customer identification". It is used to associate payments with the customer and invoice.
            * ocr - 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.
          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: |
            The `invoice_id`
            of the payment reference number (PRN) resource is the unique identifier assigned to the invoice that the PRN is associated with.
          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: |
        Payment schedules for an invoice refer to a payment structure where the `amount_due`
        on an invoice is divided into smaller, more manageable parts, each of which is paid over a specified period.

        `reference_transactions[]` lists the payment attempts referenced against those installments.
      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: |
            The identifier of the `payment_schedule_scheme`
            , used to create the payment schedules.
          maxLength: 40
          example: null
        entity_type:
          type: string
          deprecated: false
          description: |
            Specifies the types of entity this payment schedule is based on.

            * invoice - Indicates the invoice entity type
          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: |
            The part of the `invoice.amount_due`
            to be distributed across the payment schedules. If not specified, the entire `invoice.amount_due`
            is considered by default.
          minimum: 0
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The timestamp at which the `payment_schedule`
            was created.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            Version number of this resource. The `resource_version`
            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.
          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: |
                  The remaining amount due on this schedule entry. Decreases as payments are applied. When this value reaches `0`, `status` is `paid`.
                minimum: 0
                example: null
              scheduled_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The original installment amount for this schedule entry. This value does not change when payments are applied.
                minimum: 0
                example: null
              status:
                type: string
                deprecated: false
                description: |
                  Defines the status for each payment schedule.

                  * posted - The installment is unpaid or partially paid and the due date (`date`) has not passed.
                  * payment_due - The installment is unpaid or partially paid and the due date (`date`) has passed.
                  * paid - The installment has been paid.
                enum:
                - posted
                - payment_due
                - paid
                example: null
            required:
            - amount
            - date
            - id
            - scheduled_amount
            - status
            example: null
          example: null
        reference_transactions:
          type: array
          deprecated: false
          description: |
            The list of transactions referenced against the schedule entries of this payment schedule, most recent first. A transaction referenced against more than one schedule entry appears once per entry.
          items:
            type: object
            deprecated: false
            properties:
              schedule_entry_id:
                type: string
                deprecated: false
                description: |
                  The identifier of the [`schedule_entries[]`](/docs/api/payment_schedules/payment_schedule-object#schedule_entries) item this transaction is linked to.
                maxLength: 40
                example: null
              applied_amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The amount of this transaction applied to this schedule entry. `0` for failed and in-progress transactions until the payment settles.
                minimum: 0
                example: null
              txn_id:
                type: string
                deprecated: false
                description: |
                  Uniquely identifies the transaction.
                maxLength: 40
                example: null
              txn_status:
                type: string
                deprecated: false
                description: "The status of this transaction.\n\n* timeout - Transaction\
                  \ failed because of Gateway not accepting the connection.\n* voided\
                  \ - The transaction got voided or authorization expired at gateway.\n\
                  * failure - Transaction failed. Refer the 'error_code' and 'error_text'\
                  \ fields to know the reason for failure\n* in_progress -\n  Transaction\
                  \ is being processed by the gateway. This typically happens for\
                  \ [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html)\n\
                  \  or, in case of cards, refund transactions. Such transactions\
                  \ can take 2-7 days to complete, depending on the gateway and payment\
                  \ method.\n* success - The transaction is successful.\n* late_failure\
                  \ - 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.\n\
                  * needs_attention -\n  When connection with the Gateway gets terminated\
                  \ abruptly. For `needs_attention`\n  status Chargebee automatically\
                  \ reconcile the transaction for few gateways, for rest of the gateways\
                  \ you have to use the [Reconcile transaction API](/docs/api/transactions/reconcile-transaction).\n\
                  \  You can use this API to update the `id_at_gateway`\n  (Gateway\
                  \ Transaction ID) and `status`\n  for a [`needs_attention`](/docs/api/transactions/transaction-object#status)\n\
                  \  transaction to be reconciled at par with the gateway.  \n  [Learn\
                  \ more](https://www.chargebee.com/docs/payments/2.0/needs-attention-transactions.html)\n\
                  \  about `needs_attention`\n  transaction status\n"
                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:
            - schedule_entry_id
            - txn_id
            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
              scheduled_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
            - scheduled_amount
            - status
            example: null
          example: null
      required:
      - amount
      - entity_type
      - id
      - scheme_id
      example: null
    PaymentScheduleScheme:
      type: object
      description: |
        Payment schedules for an invoice refer to a payment structure where the `amount_due`
        on an invoice is divided into smaller, more manageable parts, each of which is paid over a specified period. Payment schedule scheme is a configuration or set of rules for creating payment schedules. After creating a payment schedule scheme, you can use it to generate payment schedules for multiple invoices.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            An auto-generated unique identifier for the payment schedule scheme.
          maxLength: 40
          example: null
        name:
          type: string
          deprecated: false
          description: |
            The name of a payment schedule scheme.
          maxLength: 100
          example: null
        description:
          type: string
          deprecated: false
          description: |
            A brief description for this payment schedule scheme.
          maxLength: 200
          example: null
        number_of_schedules:
          type: integer
          format: int32
          deprecated: false
          description: |
            Specifies the total number of payment schedules for the invoice. The maximum `number_of_schedules`
            varies based on the `period_unit`
            : - **Day**: Up to 30 schedules

            * **Week**: Up to 52 schedules
            * **Month**: Up to 12 schedules
          maximum: 52
          minimum: 1
          example: null
        period_unit:
          type: string
          deprecated: false
          description: |
            Defines the time unit for intervals between payment schedules. Possible values are: day, week, and month.

            * month - When the time unit for intervals between payment schedules is set as month
            * week - When the time unit for intervals between payment schedules is set as week
            * day - When the time unit for intervals between payment schedules is set as day
          enum:
          - day
          - week
          - month
          example: null
        period:
          type: integer
          format: int32
          deprecated: false
          description: |
            The time period between the effective dates of two consecutive payment schedules, expressed in period_units. Use this parameter to have fixed intervals between payment schedules. The maximum `period`
            varies based on the `period_unit`
            : - **Day**: Up to 30 days

            * **Week**: Up to 6 weeks
            * **Month**: Up to 6 months
          maximum: 30
          minimum: 1
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The timestamp at which the `payment_schedule_scheme`
            was created.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            Version number of this resource. The `resource_version`
            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.
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Defines the timestamp when the config was last updated
          example: null
      required:
      - created_at
      - id
      - number_of_schedules
      - period_unit
      example: null
    PaymentScheduleSchemeCreatedEvent:
      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_schedule_scheme:
              $ref: "#/components/schemas/PaymentScheduleScheme"
            flexible_schedules:
              type: object
              description: JSON object
              example: null
          required:
          - flexible_schedules
          - payment_schedule_scheme
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    PaymentScheduleSchemeDeletedEvent:
      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_schedule_scheme:
              $ref: "#/components/schemas/PaymentScheduleScheme"
            flexible_schedules:
              type: object
              description: JSON object
              example: null
          required:
          - flexible_schedules
          - payment_schedule_scheme
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    PaymentSchedulesCreatedEvent:
      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_schedule:
              $ref: "#/components/schemas/PaymentSchedule"
          required:
          - payment_schedule
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    PaymentSchedulesUpdatedEvent:
      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_schedule:
              $ref: "#/components/schemas/PaymentSchedule"
          required:
          - payment_schedule
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      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: |
            Version number of this resource. The `resource_version`
            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.
          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\n* direct_debit - Represents bank\
            \ account for which the direct debit or ACH agreement/mandate is created.\n\
            * unionpay - Payments made via UnionPay.\n* mercado_pago - Payments made\
            \ via Mercado Pago.\n* sepa_instant_transfer - Payments made via Sepa\
            \ Instant Transfer\n* dotpay - Payments made via Dotpay.\n* klarna - Payments\
            \ made via Klarna.\n* giropay - Payments made via giropay.\n* grab_pay\
            \ - Payments made via GrabPay\n* stablecoin - Payments made via Stablecoin.\n\
            * p24 - Payments made via Przelewy24 (P24).\n* nupay - Payments made via\
            \ NuPay.\n* picpay - Payments made via PicPay.\n* bancontact - Payments\
            \ made via Bancontact Card.\n* nequi - Payments made via Nequi.\n* amazon_payments\
            \ - Payments made via Amazon Payments.\n* pay_by_bank - Pay By Bank\n\
            * online_banking_poland - Payments made via Online Banking Poland\n* touch_n_go\
            \ - Payments made via Touch 'n Go.\n* after_pay - Payments made via Afterpay\n\
            * momo - Payments made via MoMo.\n* fpx - Payments made via FPX.\n* paypay\
            \ - Payments made via PayPay\n* generic - Payments made via Generic Payment\
            \ Method.\n* twint - Payments made via Twint\n* automated_bank_transfer\
            \ - Represents virtual bank account using which the payment will be done.\n\
            * paypal_express_checkout - Payments made via PayPal Express Checkout.\n\
            * trustly - Trustly\n* upi - UPI Payments.\n* cash_app_pay - Payments\
            \ made via Cash App Pay.\n* south_korean_cards - Payments made via South\
            \ Korean Cards\n* qpay - Payments made via Qpay.\n* affirm_pay - Payments\
            \ made via Affirm Pay.\n* electronic_payment_standard - Electronic Payment\
            \ Standard\n* ovo - Payments made via OVO.\n* google_pay - Payments made\
            \ via Google Pay.\n* pay_to - Payments made via PayTo\n* revolut_pay -\
            \ Payments made via Revolut Pay.\n* thai_qr - Payments made via Thai QR.\n\
            * naver_pay - Payments made via Naver Pay.\n* rakuten_pay - Payments made\
            \ via Rakuten Pay.\n* blik - Payments made via BLIK.\n* alipay -\n  Payments\
            \ made via Alipay.  \n  This payment source is deprecated.\n* kakao_pay\
            \ - Payments made via Kakao Pay.\n* sofort - Payments made via Sofort.\n\
            * gcash - Payments made via GCash.\n* dana - Payments made via Dana.\n\
            * pix - Payments made via Pix\n* pay_co - Payments made via PayCo\n* wechat_pay\
            \ -\n  Payments made via WeChat Pay.  \n  This payment source is deprecated.\n\
            * netbanking_emandates - Netbanking (eMandates) Payments.\n* go_pay -\
            \ Payments made via GoPay\n* card - Card based payment including credit\
            \ cards and debit cards. Details about the card can be obtained from the\
            \ card resource.\n* faster_payments - Payments made via Faster Payments\n\
            * alipay_hk - Payments made via Alipay HK.\n* payme - Payments made via\
            \ PayMe\n* tamara - Payments made via Tamara.\n* klarna_pay_now - Payments\
            \ made via Klarna Pay Now\n* swish - Payments made via Swish\n* venmo\
            \ - Payments made via Venmo\n* ideal - Payments made via iDEAL.\n* wero\
            \ - Payments made via Wero.\n* kbc_payment_button - KBC Payment Button\n\
            * payconiq_by_bancontact - Payments made via Payconiq by Bancontact.\n\
            * apple_pay - Payments 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
          - alipay_hk
          - paypay
          - gcash
          - south_korean_cards
          - paynow
          - bizum
          - promptpay
          - dana
          - touch_n_go
          - tamara
          - qpay
          - ovo
          - momo
          - mercado_pago
          - nequi
          - nupay
          - picpay
          - thai_qr
          - blik
          - fpx
          - wero
          - p24
          - affirm_pay
          - rakuten_pay
          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\n\
            * bluesnap - BlueSnap is a payment gateway.\n* jp_morgan -\n  J.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).\
            \  \n  This 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 - 2Checkout is a payment gateway.\n\
            * payway - Payway is a payment gateway that enables secure card and payment\
            \ acceptance.\n* 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.\n* dlocal - Dlocal\
            \ provides payment solutions for global commerce by accepting local payment\
            \ methods.\n* checkout_com - Checkout.com is a payment gateway.\n* adyen\
            \ - Adyen is a payment gateway.\n* braintree - Braintree is a payment\
            \ gateway.\n* paystack -\n  Paystack is a payment gateway for businesses\
            \ in Africa. It enables secure payment acceptance both online and offline.\
            \  \n  This 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 - Pay.com\
            \ provides payment services focused on simplicity and hassle-free operations\
            \ for businesses of all sizes.\n* moneris_us - Moneris USA is a payment\
            \ gateway.\n* pin - Pin is a payment gateway\n* moneris - Moneris is a\
            \ payment gateway.\n* chargebee - Chargebee test gateway.\n* cybersource\
            \ - CyberSource is a payment gateway.\n* ecentric - Ecentric provides\
            \ a seamless payment processing service in South Africa specializing on\
            \ omnichannel capabilities.\n* first_data_global - First Data Global Gateway\
            \ Virtual Terminal Account\n* exact - Exact Payments is a payment gateway.\n\
            * nuvei -\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.  \n  This 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 - eWAY Account\
            \ is a payment gateway.\n* payu - PayU is a payment gateway that enables\
            \ secure card payment acceptance via PaymentsOS.\n* amazon_payments -\
            \ Amazon Payments is a payment service provider.\n* sage_pay - Sage Pay\
            \ is a payment gateway.\n* elavon - Elavon Virtual Merchant is a payment\
            \ solution.\n* orbital - Chase Paymentech(Orbital) is a payment gateway.\n\
            * beanstream - Bambora(formerly known as Beanstream) is a payment gateway.\n\
            * hdfc - HDFC Account is a payment gateway.\n* bank_of_america - Bank\
            \ of America Gateway\n* gocardless - GoCardless is a payment service provider.\n\
            * paymill - PAYMILL is a payment gateway.\n* balanced_payments - Balanced\
            \ is a payment gateway\n* twikey - Twikey is a payment service provider\
            \ that specializes in processing direct debit payments across the EU.\n\
            * moyasar - Moyasar is a fully integrated online payment service that\
            \ makes accepting payments simple and secure.\n* deutsche_bank -\n  Deutsche\
            \ Bank is the leading German bank with strong European roots and a global\
            \ network.  \n  This feature is a **Private Beta Release**.\n* bluepay\
            \ - BluePay is a payment gateway.\n* paypal_express_checkout - PayPal\
            \ Express Checkout is a payment gateway.\n* paypal_payflow_pro - PayPal\
            \ Payflow Pro is a payment gateway.\n* global_payments - Global Payments\
            \ is a payment service provider.\n* not_applicable - Indicates that payment\
            \ gateway is not applicable for this resource.\n* nmi - NMI is a payment\
            \ gateway.\n* worldpay - WorldPay is a payment gateway\n* authorize_net\
            \ - Authorize.net is a payment gateway\n* tempus - Tempus Technologies\
            \ is a payment gateway and payments technology provider offering secure\
            \ payment processing with point-to-point encryption (P2PE) and tokenization.\n\
            * stripe - Stripe is a payment gateway.\n* metrics_global - Metrics global\
            \ is a leading payment service provider providing unified payment services\
            \ in the US.\n* windcave - Windcave provides an end to end payment processing\
            \ solution in ANZ and other leading global markets.\n* quickbooks - Intuit\
            \ QuickBooks Payments gateway\n* wepay - WePay is a payment gateway.\n\
            * ezidebit -\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* wirecard - WireCard\
            \ Account is a payment service provider.\n* chargebee_payments - Chargebee\
            \ Payments gateway\n* paypal_pro - PayPal Pro Account is a payment gateway.\n\
            * paypal - PayPal Commerce is a payment gateway.\n* ingenico_direct -\
            \ Worldline Online Payments is a payment gateway.\n* ogone - Ingenico\
            \ ePayments (formerly known as Ogone) is a payment gateway.\n* migs -\
            \ MasterCard Internet Gateway Service payment gateway.\n* vantiv - Vantiv\
            \ is a payment gateway.\n* eway_rapid - eWAY Rapid is a payment gateway.\n\
            * mollie - Mollie is a payment gateway.\n* solidgate -\n  Solidgate is\
            \ a secure and reliable payment processing solution that allows you to\
            \ accept payments from customers and suitable for various types of businesses.\
            \  \n  This feature is a **Private Beta Release**.\n* ebanx - EBANX 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
          - payu
          - 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
        vault_token:
          type: object
          additionalProperties: true
          deprecated: false
          description: |
            When present, the payment source has been vaulted. Contains `status` (`active` or `inactive`), `created_at`, and `updated_at` as Unix timestamps in seconds.
          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 unique ID of the [business entity](/docs/api/advanced-features)
            of this `payment_source`.
            This is always the same as the business entity of the [customer](/docs/api/payment_sources/payment_source-object#customer_id).
          maxLength: 50
          example: null
        brand_id:
          type: string
          deprecated: false
          description: |
            The unique ID of the [brand](/docs/api/brands) this payment source belongs to. Unless a brand was specified in the request, this is the brand of the customer the payment source was created for.
          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
              description: |
                Email address of the cardholder
              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.
                * 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.
                * hipercard - An Hipercard.
                * bancontact - A Bancontact card.
                * rupay - A Rupay card.
                * nativa - A Nativa 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
              - 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: |
                The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
                without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `billing_state_code`
                as `AZ`
                (not `US-AZ`
                ). For Tamil Nadu (India), set as `TN`
                (not `IN-TN`
                ). For British Columbia (Canada), set as `BC`
                (not `CA-BC`
                ). For Dubai (UAE), set as `DU`
                (not `AE-DU`
                ).
              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: "The billing address country of the customer. Must be one\
                \ of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                .\n\n**Note**:\nIf you enter an invalid country code, the system will\
                \ return an error.  \n**Brexit**\n\nIf you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                \ the Brexit configuration, then `XI` (the code for **United Kingdom\
                \ - Northern Ireland**) is available as an option.\n"
              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: |
                The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
                without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                as `AZ`
                (not `US-AZ`
                ). For Tamil Nadu (India), set as `TN`
                (not `IN-TN`
                ). For British Columbia (Canada), set as `BC`
                (not `CA-BC`
                ). For Dubai (UAE), set as `DU`
                (not `AE-DU`
                ).
              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 country of the customer. Must be one\
                \ of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                .\n\n**Note**:\nIf you enter an invalid country code, the system will\
                \ return an error.  \n**Brexit**\n\nIf you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                \ the Brexit configuration, then `XI` (the code for **United Kingdom\
                \ - Northern Ireland**) is available as an 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.

                * 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
        network_transaction_reference:
          type: object
          deprecated: false
          properties:
            original_network_transaction_id:
              type: string
              deprecated: false
              maxLength: 100
              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
    PaymentSourceBusinessEntityChangedEvent:
      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:
            business_entity_transfer:
              $ref: "#/components/schemas/BusinessEntityTransfer"
            payment_source:
              $ref: "#/components/schemas/PaymentSource"
          required:
          - business_entity_transfer
          - 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 the 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: "The gateway through which this payment voucher was created.\n\
            **Note** :\nNote: Currently, `stripe`\nis the only supported gateway through\
            \ which you can create the payment voucher.\n\n* twikey - Twikey is a\
            \ payment service provider that specializes in processing direct debit\
            \ payments across the EU.\n* ecentric - Ecentric provides a seamless payment\
            \ processing service in South Africa specializing on omnichannel capabilities.\n\
            * bluesnap - BlueSnap is a payment gateway.\n* jp_morgan -\n  J.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).\
            \  \n  This 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 - 2Checkout is a payment gateway.\n\
            * first_data_global - First Data Global Gateway Virtual Terminal Account\n\
            * payway - Payway is a payment gateway that enables secure card and payment\
            \ acceptance.\n* moyasar - Moyasar is a fully integrated online payment\
            \ service that makes accepting payments simple and secure.\n* exact -\
            \ Exact Payments is a payment gateway.\n* deutsche_bank -\n  Deutsche\
            \ Bank is the leading German bank with strong European roots and a global\
            \ network.  \n  This feature is a **Private Beta Release**.\n* bluepay\
            \ - BluePay is a payment gateway.\n* paypal_express_checkout - PayPal\
            \ Express Checkout is a payment gateway.\n* nuvei -\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.  \n  This\
            \ 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 - eWAY Account\
            \ is a payment gateway.\n* metrics_global - Metrics global is a leading\
            \ payment service provider providing unified payment services in the US.\n\
            * payu - PayU is a payment gateway that enables secure card payment acceptance\
            \ via PaymentsOS.\n* paypal_payflow_pro - PayPal Payflow Pro is a payment\
            \ gateway.\n* 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.\n* global_payments -\
            \ Global Payments is a payment service provider.\n* amazon_payments -\
            \ Amazon Payments is a payment service provider.\n* dlocal - Dlocal provides\
            \ payment solutions for global commerce by accepting local payment methods.\n\
            * not_applicable - Indicates that payment gateway is not applicable for\
            \ this resource.\n* windcave - Windcave provides an end to end payment\
            \ processing solution in ANZ and other leading global markets.\n* checkout_com\
            \ - Checkout.com is a payment gateway.\n* adyen - Adyen is a payment gateway.\n\
            * braintree - Braintree is a payment gateway.\n* nmi - NMI is a payment\
            \ gateway.\n* quickbooks - Intuit QuickBooks Payments gateway\n* wepay\
            \ - WePay is a payment gateway.\n* worldpay - WorldPay is a payment gateway\n\
            * paystack -\n  Paystack is a payment gateway for businesses in Africa.\
            \ It enables secure payment acceptance both online and offline.  \n  This\
            \ 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  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 - Pay.com provides payment\
            \ services focused on simplicity and hassle-free operations for businesses\
            \ of all sizes.\n* wirecard - WireCard Account is a payment service provider.\n\
            * chargebee_payments - Chargebee Payments gateway\n* sage_pay - Sage Pay\
            \ is a payment gateway.\n* moneris_us - Moneris USA is a payment gateway.\n\
            * pin - Pin is a payment gateway\n* authorize_net - Authorize.net is a\
            \ payment gateway\n* elavon - Elavon Virtual Merchant is a payment solution.\n\
            * paypal_pro - PayPal Pro Account is a payment gateway.\n* orbital - Chase\
            \ Paymentech(Orbital) is a payment gateway.\n* paypal - PayPal Commerce\
            \ is a payment gateway.\n* beanstream - Bambora(formerly known as Beanstream)\
            \ is a payment gateway.\n* hdfc - HDFC Account is a payment gateway.\n\
            * ingenico_direct - Worldline Online Payments is a payment gateway.\n\
            * ogone - Ingenico ePayments (formerly known as Ogone) is a payment gateway.\n\
            * migs - MasterCard Internet Gateway Service payment gateway.\n* tempus\
            \ - Tempus Technologies is a payment gateway and payments technology provider\
            \ offering secure payment processing with point-to-point encryption (P2PE)\
            \ and tokenization.\n* stripe - Stripe is a payment gateway.\n* vantiv\
            \ - Vantiv is a payment gateway.\n* moneris - Moneris is a payment gateway.\n\
            * bank_of_america - Bank of America Gateway\n* chargebee - Chargebee test\
            \ gateway.\n* eway_rapid - eWAY Rapid is a payment gateway.\n* gocardless\
            \ - GoCardless is a payment service provider.\n* mollie - Mollie is a\
            \ payment gateway.\n* paymill - PAYMILL is a payment gateway.\n* balanced_payments\
            \ - Balanced is a payment gateway\n* solidgate -\n  Solidgate is a secure\
            \ and reliable payment processing solution that allows you to accept payments\
            \ from customers and suitable for various types of businesses.  \n  This\
            \ feature is a **Private Beta Release**.\n* cybersource - CyberSource\
            \ is a payment gateway.\n* ebanx - EBANX 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
          - payu
          - 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: |
            Version number of this resource. The `resource_version`
            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.
          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: |
            The unique 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
          - migrate_subscription_item_tiers
          - 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
    Pc2PreviewApproval:
      type: object
      properties:
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        approval_required:
          type: boolean
          default: false
          deprecated: false
          example: null
        preview_id:
          type: string
          deprecated: false
          maxLength: 40
          example: null
        approval_details:
          type: object
          deprecated: false
          properties:
            rule_name:
              type: string
              deprecated: false
              maxLength: 50
              example: null
            version:
              type: string
              deprecated: false
              maxLength: 50
              example: null
            rule_id:
              type: string
              deprecated: false
              maxLength: 50
              example: null
            stages:
              type: array
              deprecated: false
              items:
                type: object
                deprecated: false
                properties:
                  name:
                    type: string
                    deprecated: false
                    maxLength: 50
                    example: null
                  approver_policy:
                    type: string
                    deprecated: false
                    maxLength: 50
                    example: null
                  users:
                    type: array
                    deprecated: false
                    items:
                      type: object
                      deprecated: false
                      properties:
                        name:
                          type: string
                          deprecated: false
                          maxLength: 50
                          example: null
                        email:
                          type: string
                          deprecated: false
                          maxLength: 100
                          example: null
                      required:
                      - email
                      - name
                      example: null
                    example: null
                required:
                - approver_policy
                - name
                example: null
              example: null
            conditions:
              type: array
              deprecated: false
              items:
                type: object
                deprecated: false
                properties:
                  operand:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  operator:
                    type: string
                    deprecated: false
                    maxLength: 100
                    example: null
                  value:
                    type: string
                    deprecated: false
                    maxLength: 65000
                    example: null
                required:
                - operand
                - operator
                example: null
              example: null
          required:
          - rule_id
          - rule_name
          - version
          example: null
      required:
      - created_at
      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: |
        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 [Growth Solutions](https://www.chargebee.com/docs/retention/getting-started-guide/chargebee-growth-solutions).
        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:

        * `Acquire`: Incentivize trial users or prospects to subscribe.
        * `Expand`: Encourage existing subscribers to purchase higher-value products or add-ons.
        * `Retain`: Engage at-risk subscribers with targeted winbacks or discounts.

        **Note:** Growth solutions are currently in **Early Access** 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 [Chargebee Growth Early Access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/chargebee-growth&ref=feature) page in Chargebee Billing.

        **Features of this object**

        The Personalized Offers object enables you to:

        * Fetch context-aware offers generated by the Growth system.
        * Display offer content (title and description) to subscribers.
        * Provide subscribers with options they can act on.
        * Attribute offers to the correct brand (for multi-brand merchants).
        * Respect time-bound validity with the expires_at attribute.
      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 and\
            \ description. \\*\\*Tip\\*\\* The content is formatted in HTML and can\
            \ be rendered safely in the DOM. However, the code may contain empty \\\
            `  \n\\` elements of the form \\`  \n\\`. Replace these with one or two\
            \ newlines to preserve the intended line breaks.\n"
          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: |
                  Defines what happens after a customer accepts an offer and how the offer benefit is fulfilled. [Learn more](https://www.chargebee.com/docs/growth/offers/in-app-offers#offer-processing).

                  * email - Chargebee sends an email as configured in Growth, and the fulfillment is processed by your system.
                  * checkout - The offer is fulfilled by Chargebee via a Chargebee-hosted [Checkout](https://www.chargebee.com/docs/billing/2.0/hosted-capabilities/hosted-checkout) flow.
                  * webhook - Chargebee triggers webhook and fulfillment is processed by your system.
                  * url_redirect - Chargebee provides the `redirect_url` as configured in Growth, and the fulfillment is processed by your system.
                  * billing_update - The offer is fulfilled by Chargebee by applying the offer benefit directly to the subscription.
                enum:
                - billing_update
                - checkout
                - url_redirect
                - webhook
                - email
                example: null
              processing_layout:
                type: string
                deprecated: false
                description: |
                  Specifies the [UI layout](https://www.chargebee.com/docs/billing/2.0/hosted-capabilities/hosted-checkout#ui-layout-options) for Checkout.

                  * 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
    PlatformAccount:
      type: object
      description: |
        Represents a platform account in Chargebee.
        Each platform account includes a unique `id` and can optionally include `partner_name` and `partner_description`.
      properties:
        site_id:
          type: string
          deprecated: false
          maxLength: 60
          example: null
        id:
          type: string
          deprecated: false
          description: |
            Unique identifier of the platform account. Maximum length is 40 characters.
          maxLength: 40
          example: null
        partner_name:
          type: string
          deprecated: false
          description: |
            Name of the partner associated with this platform account. Maximum length is 50 characters.
          maxLength: 50
          example: null
        partner_description:
          type: string
          deprecated: false
          description: |
            Description of the partner associated with this platform account. Maximum length is 250 characters.
          maxLength: 250
          example: null
        settings_json:
          type: string
          deprecated: false
          maxLength: 65000
          example: null
      required:
      - id
      - site_id
      example: null
    PortalSession:
      type: object
      description: "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.\n\n**Note:** You can instead allow your customers to access\
        \ the portal via login page provided by Chargebee. [Read more](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html).\n\
        \nPlease follow the below steps for supporting portal access via SSO:\n\n\
        1. To enable the \"Allow access to customer portal via API\", click **Settings**\
        \ \\> **Configure Chargebee** \\> **Customer Facing Essentials** \\> **Checkout\
        \ and Self Serve Portal** \\> **Portal**.\n2. Provide a link in your website/application\
        \ which your authenticated customers can use to access the portal (For example,\
        \ `{your_website_url}/portal_link`).\n3. Handle the link request in your server\
        \ code and create a portal session for the customer by calling Chargebee's\
        \ \"Create a portal session\" API\n4. Forward the user to the access URL present\
        \ in the \"Portal Session\" resource returned by the above API call.\n\n**Notes\
        \ about access URL:**\n\n* The access URL should be accessed by the customer\
        \ within one hour from the time it was created.\n* 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.\n* 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.  \nUsing\
        \ Chargebee's authentication  \n**Note:** This feature is not supported in\
        \ [in-app](https://www.chargebee.com/docs/inapp-self-serve-portal.html) portal.\n\
        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.\n**Workflow:**\n\nUsers\
        \ should be redirected to the portal login URL - **https://yourdomain.chargebeeportal.com/portal/login**\
        \ by passing the following parameters:\n\n* **return_url** - URL the users\
        \ should be redirected to upon successful authentication.\n* **cancel_url**\
        \ - 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 'Whitelisted Domain' in Chargebee. Add just the domain name\
        \ in Chargebee and not the entire URL: E.g. yourdomain.com.\n\nUpon successful\
        \ authentication, a session is created for the user and Chargebee redirects\
        \ the user to the return_url along with the following parameters:\n\n* **auth_session_id**\
        \ - Identifier to the authenticated session.\n* **auth_session_token** - Token\
        \ for the session which should be sent later to activate this session. Using\
        \ the **auth_session_id** \\& **auth_session_token** , you should call [Activate\
        \ a Portal Session](/docs/api/portal_sessions/activate-a-portal-session) API\
        \ to validate the session details and create a session for that user in your\
        \ website. **Note:** The process of setting up the portal account will take\
        \ place along with the authentication process.  \nScheduled subscription changes\
        \  \n* When [Ramps](ramps) are disabled, the customer can view and edit the\
        \ single scheduled change if it exists.\n\n* When [Ramps](ramps) are enabled\
        \ with compatibility mode:\n\n  * The customer can view and edit the first\
        \ ramp if it exists.\n  * If they edit the subscription, the impacts are the\
        \ same as those described in the documentation for [`changes_scheduled_at`](subscriptions#update_subscription_for_items_changes_scheduled_at)\
        \ parameter in the Update subscription API.\n\n  For more details, see [Ramps\
        \ API compatibility mode](subscriptions#ramps-compat-mode).\n"
      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.

            * 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.
            * 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.
          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
    PreferenceVariant:
      type: object
      properties: {}
      example: null
    PriceType:
      type: string
      default: tax_exclusive
      deprecated: false
      enum:
      - tax_exclusive
      - tax_inclusive
      example: null
    PriceVariant:
      type: object
      description: "Price variant resource offers businesses the flexibility to manage\
        \ pricing for multiple variations of an [item](/docs/api/items) (plan, addon,\
        \ or charge) in the Product Catalog. It enables the creation of diverse pricing\
        \ structures based on variables such as geography, partners, versions, and\
        \ more.  \n**See also:**\nFor a more detailed understanding of Price Variants,\
        \ including how to enable, configure, and manage them, as well as their impact\
        \ on other features, follow these resources:\n\n* [Price Variant Overview](https://www.chargebee.com/docs/2.0/variant-pricing-overview.html)\n\
        * [Enabling Price Variant](https://www.chargebee.com/docs/2.0/variant-pricing-enable.html)\n\
        * [Configuring Price Variant](https://www.chargebee.com/docs/2.0/variant-pricing-config.html)\n\
        * [Impacted Features by Price Variant](https://www.chargebee.com/docs/2.0/variant-pricing-impacted-features.html)\n"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            The unique and immutable identifier of the price variant.
          maxLength: 100
          example: null
        name:
          type: string
          deprecated: false
          description: |
            A unique name of the price variant.
          maxLength: 100
          example: null
        external_name:
          type: string
          deprecated: false
          description: |
            A unique display name for the price variant.
          maxLength: 100
          example: null
        variant_group:
          type: string
          deprecated: false
          description: |
            The `variant_group`
            organizes similar [price_variants](/docs/api/price_variants)
            to optimize strategies such as bundling, geo-based pricing experiments, and campaign-specific pricing like `cb-atomic-pricing-`
            for effective grouping. The `variant_group`
            provides greater flexibility and precision in your pricing models.
          maxLength: 100
          example: null
        description:
          type: string
          deprecated: false
          description: |
            Description of the price variant.
          maxLength: 500
          example: null
        status:
          type: string
          deprecated: false
          description: |
            Status of a price variant.

            * active -
              Active price variant. This price variant can be attached to [item prices](/docs/api/item_prices)
              .
            * deleted -
              Deleted price variant. The `id`
              and `name`
              of the deleted price variant can be reused.
            * archived -
              Archived price variant. This price variant is no longer `active`
              and cannot be attached to new [item prices](/docs/api/item_prices).
              Existing item prices that already have this price variant attached will continue to remain as is.
          enum:
          - active
          - archived
          - deleted
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this price variant is created.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            The version number of this resource. For every change made to the resource, `resource_version`
            is updated with a new timestamp in milliseconds.
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this price variant was last updated.
          example: null
        archived_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this price variant was archived.
          example: null
        business_entity_id:
          type: string
          deprecated: false
          description: |
            The unique ID of the
            [business entity](/docs/api/business_entities)
            of this `price_variant`.
            This is applicable only when multiple business entities have been created for the site. The value of this attribute indicates that the resource is specific to the given business entity.
          maxLength: 50
          example: null
        deleted:
          type: boolean
          deprecated: false
          description: |
            Indicates whether the price variant has been deleted or not.
          example: null
        attributes:
          type: array
          deprecated: false
          description: |
            The list of price variant attribute values.
            Attributes can be used to store additional information about the price variant. For example, for a price variant called 'Germany', the attributes can be 'Country':'Germany', 'City':'Berlin' and so on.
          items:
            type: object
            deprecated: false
            properties:
              name:
                type: string
                deprecated: false
                description: |
                  Attribute name
                maxLength: 100
                example: null
              value:
                type: string
                deprecated: false
                description: |
                  Attribute value
                maxLength: 100
                example: null
            required:
            - name
            - value
            example: null
          example: null
      required:
      - created_at
      - deleted
      - id
      - name
      example: null
    PriceVariantCreatedEvent:
      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:
            price_variant:
              $ref: "#/components/schemas/PriceVariant"
            attribute:
              $ref: "#/components/schemas/Attribute"
          required:
          - attribute
          - price_variant
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    PriceVariantDeletedEvent:
      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:
            price_variant:
              $ref: "#/components/schemas/PriceVariant"
            attribute:
              $ref: "#/components/schemas/Attribute"
          required:
          - attribute
          - price_variant
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    PriceVariantUpdatedEvent:
      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:
            price_variant:
              $ref: "#/components/schemas/PriceVariant"
            attribute:
              $ref: "#/components/schemas/Attribute"
          required:
          - attribute
          - price_variant
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    PricingModel:
      type: string
      deprecated: false
      enum:
      - flat_fee
      - per_unit
      - tiered
      - volume
      - stairstep
      example: null
    PricingPageSession:
      type: object
      description: |
        The `pricing_page_session`
        resource allows you to create a pricing page that incorporates customer and subscription details. This page helps customers choose a plan, start a new subscription, or modify an existing one. Each session is distinct and has a limited duration, ensuring a unique and time-sensitive experience.
      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 can 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
    Product:
      type: object
      description: |
        Products are offerings that can be sold to customers either as one-time purchases or as recurring subscriptions. These products could include physical items, digital goods, or services that are delivered over a period of time. Chargebee's API allows developers to interact with and manipulate product data, enabling businesses to seamlessly integrate their product offerings into their subscription management workflows.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            The immutable unique identifier of the product.
          maxLength: 100
          example: null
        name:
          type: string
          deprecated: false
          description: |
            A unique display name for the product. This is visible only in Chargebee.
          maxLength: 100
          example: null
        external_name:
          type: string
          deprecated: false
          description: |
            This is a unique name appears for each product to the end user.
          maxLength: 100
          example: null
        description:
          type: string
          deprecated: false
          description: |
            Description of the product.
          maxLength: 500
          example: null
        has_variant:
          type: boolean
          default: true
          deprecated: false
          description: |
            Whether the product has variants or not.
          example: null
        status:
          type: string
          default: active
          deprecated: false
          description: |
            Status of the product.

            * active - The active products are visible on the storefront, subscription, or checkout.
            * inactive - The inactive products are not visible on the storefront, subscription, or checkout.
          enum:
          - active
          - inactive
          example: null
        shippable:
          type: boolean
          default: true
          deprecated: false
          description: |
            Whether a product is shippable or not.
          example: null
        sku:
          type: string
          deprecated: false
          description: |
            A unique identifier code a seller assigns to each product or item. Retailers and merchants use SKUs to keep track of inventory and sales data and help organize products within a store or warehouse. SKUs can include a combination of letters, numbers, and symbols and can vary in length depending on the seller's needs.
          maxLength: 100
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp when the product was created.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            Version number of this resource. The `resource_version`
            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.
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this product was last updated
          example: null
        deleted:
          type: boolean
          default: false
          deprecated: false
          description: |
            Determines if the product is deleted or not. If the value is `true`
            then the product has been deleted else it exists. Once the product is deleted, you can reuse the product `id`
            and `name`
            .
          example: null
        metadata:
          type: object
          additionalProperties: true
          deprecated: false
          description: "A collection of key-value pairs that provides extra information\
            \ about the product.  \n**Note:**\nThere's a character limit of 65,535.\n\
            \n[Learn more](/docs/api/advanced-features#metadata)\n.\n"
          example: null
        options:
          type: array
          deprecated: false
          description: |
            Array of option list which helps in the product variant creation.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  The identifier of an option.
                maxLength: 100
                example: null
              name:
                type: string
                deprecated: false
                description: |
                  Name of the option.
                maxLength: 100
                example: null
              values:
                type: array
                deprecated: false
                description: |
                  List of values for the option.
                items:
                  example: null
                example: null
              default_value:
                type: string
                deprecated: false
                description: |
                  Default value for the option.
                maxLength: 100
                example: null
              type:
                type: string
                deprecated: false
                description: |
                  Type of options.

                  * select - select
                enum:
                - select
                example: null
            example: null
          example: null
      required:
      - created_at
      - deleted
      - external_name
      - has_variant
      - id
      - name
      - shippable
      - status
      example: null
    ProductCatalogVersion:
      type: string
      deprecated: false
      enum:
      - v1
      - v2
      example: null
    ProductCreatedEvent:
      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:
            product:
              $ref: "#/components/schemas/Product"
          required:
          - product
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    ProductDeletedEvent:
      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:
            product:
              $ref: "#/components/schemas/Product"
          required:
          - product
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    ProductUpdatedEvent:
      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:
            product:
              $ref: "#/components/schemas/Product"
          required:
          - product
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      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
          description: |
            The unique identifier of the [business entity](/docs/api/business_entities)
            associated with this promotional credit.
          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
    PromotionalGrant:
      type: object
      properties:
        subscription_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        unit_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        amount:
          type: string
          deprecated: false
          maxLength: 36
          example: null
        expires_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        metadata:
          type: object
          additionalProperties: true
          deprecated: false
          example: null
      required:
      - amount
      - expires_at
      - subscription_id
      - unit_id
      example: null
    ProrationType:
      type: string
      deprecated: false
      enum:
      - full_term
      - partial_term
      - none
      example: null
    Purchase:
      type: object
      description: "**Deprecated.** The Purchase API is deprecated. It still works\
        \ and existing integrations are unaffected, but it's no longer recommended\
        \ for new integrations. Support for purchasing multiple plans in a single\
        \ subscription is planned for the [Subscriptions API](/docs/api/subscriptions).\n\
        \nThe `purchase` resource represents a collection of [item prices](/docs/api/item_prices)\
        \ bought together. A purchase can contain one or more of the following:\n\n\
        * subscriptions (a [subscription](/docs/api/subscriptions) resource consists\
        \ of item prices such that at least one of the item prices belongs to an [item](/docs/api/items)\
        \ of `type` `plan`.)\n* group of one-time charges (aka [charge item prices](/docs/api/item_prices))\n\
        \n**Prerequisite**\n\nPurchases must be enabled explicitly for the site. If\
        \ not already enabled, contact eap@chargebee.com. Purchases require the following\
        \ features to work so they're automatically enabled along with them:\n\n*\
        \ [Consolidated Invoicing](https://www.chargebee.com/docs/2.0/consolidated-invoicing.html)\n\
        * [Manual discounts](https://www.chargebee.com/docs/2.0/subscription-manual-discounts.html)\n\
        * [Multiple coupon support](https://www.chargebee.com/docs/2.0/coupons.html#applying-multiple-coupons-to-a-subscription)\n\
        * [Multi-decimal pricing and quantities](https://www.chargebee.com/docs/2.0/multi-decimal-support.html)\
        \  \n**Note**\n\nOnce created, Chargebee never modifies a `purchase` resource;\
        \ it cannot be modified via API either.\n"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            The unique identifier of the purchase resource. This is always autogenerated.
          maxLength: 100
          example: null
        customer_id:
          type: string
          deprecated: false
          description: |
            The unique identifier of the [customer](/docs/api/customers)
            that made this purchase.
          maxLength: 50
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The time at which this purchase was created.
          example: null
        modified_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The time at which the purchase was modified.
          example: null
        subscription_ids:
          type: array
          deprecated: false
          description: |
            The unique identifiers of the [subscriptions](/docs/api/subscriptions)
            that are created as part of this purchase. These IDs remain even when the associated subscriptions have been deleted.
          items:
            type: string
            deprecated: false
            maxLength: 50
            example: null
          example: null
        invoice_ids:
          type: array
          deprecated: false
          description: |
            The unique identifier of the [invoice(s)](/docs/api/invoices)
            created immediately as part of this purchase.
          items:
            type: string
            deprecated: false
            maxLength: 50
            example: null
          example: null
      required:
      - customer_id
      example: null
    PurchaseCreatedEvent:
      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:
            purchase:
              $ref: "#/components/schemas/Purchase"
          required:
          - purchase
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      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.\n\n* open - The quote is either\
            \ newly created, or has been approved but not yet sent to the customer.\n\
            * invoiced - The accepted quote has been converted into a subscription\
            \ or one-time charge and invoiced through Chargebee.\n* voided -\n  The\
            \ quote has been invalidated and can no longer be acted upon.  \n  **Note**\n\
            \n  Applicable only when Chargebee CPQ is enabled. To request access,\
            \ 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\
            * accepted - The customer has accepted the quote.\n* closed -\n  The quote\
            \ has been marked as closed.  \n  **Note**\n\n  Not applicable when Chargebee\
            \ CPQ is enabled.\n* declined - The customer declined/rejected the quote.\n\
            * proposed -\n  The quote has been shared with the customer via email\
            \ or e-signature and is awaiting their response.  \n  **Note**\n\n  Applicable\
            \ only when Chargebee CPQ is enabled. To request access, 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\
            * expired -\n  The quote has passed its expiration date and is no longer\
            \ valid.  \n  **Note**\n\n  Applicable only when Chargebee CPQ is enabled.\
            \ To request access, 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\
            * approval_rejected -\n  The quote was rejected with comments, allowing\
            \ for revisions.  \n  **Note**\n\n  Applicable only when Chargebee CPQ\
            \ is enabled. To request access, 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\
            * pending_approval -\n  The quote has been submitted for internal approval\
            \ and is awaiting review.  \n  **Note**\n\n  Applicable only when Chargebee\
            \ CPQ is enabled. To request access, 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"
          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
            * renew_subscription - renew_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: |
            Version number of this resource. The `resource_version`
            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.
          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: |
            An overridden value for the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number).
            Only applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)

            `country`
            as `XI`
            (which is **United Kingdom - Northern Ireland**
            ).

            When you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)
            in 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)
            the Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)

            `country`
            as `XI`.
            That's the code for **United Kingdom - Northern Ireland** .
            The first two characters of the VAT number in such a case is
            `XI`
            by default. However, if the VAT number was registered in UK, the value should be `GB`.
            Set
            `vat_number_prefix`
            to `GB`
            for such cases.
          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: |
            Specifies the contract term's end date. It indicates when the action set in `action_at_term_end`
            gets triggered.
          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 unique ID of the [business entity](/docs/api/advanced-features)
            of this quote.
          maxLength: 50
          example: null
        deleted:
          type: boolean
          deprecated: false
          description: |
            Indicates that this resource has been deleted when the value is `true`
            .
          example: null
        total_contract_value:
          type: integer
          format: int64
          deprecated: false
          description: |
            The total contract value of the quote.

            **Note:** This parameter applies only when Chargebee CPQ is enabled. To request access, 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)
          minimum: 0
          example: null
        total_discount:
          type: integer
          format: int64
          deprecated: false
          description: |
            The total discount value of the quote for the contract period.

            **Note:** This parameter applies only when Chargebee CPQ is enabled. To request access, 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)
          minimum: 0
          example: null
        has_entitlements:
          type: boolean
          deprecated: false
          description: |
            Indicates whether this quote has entitlement records associated with it.
          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/invoices/invoice-object#line_items_quantity)
                  which is represented by this line item. For `metered`
                  line items, this value is updated from [usages](/docs/api/usages)
                  once when the invoice is generated as `pending`
                  and finally when the invoice is [closed](/docs/api/invoices/close-a-pending-invoice)
                  .
                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/2.0/plans.html#pricing-models)
                  for this item price.

                  * 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: |
                  The decimal representation of the unit amount of the `line_item`.
                  The value is in major units of the currency. Returned when the `line_item`
                  is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 39
                example: null
              quantity_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the quantity of this line_item. Returned when the `line_item`
                  is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 33
                example: null
              amount_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the amount for the `line_item`
                  , in major units of the currency. Typically equals to `unit_amount_in_decimal`
                  x `quantity_in_decimal`.
                  Returned when [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                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
                description: |
                  Indicates whether the line item is for a metered item.If `true`
                  , the item is metered; otherwise, it is non-metered.
                example: null
              is_percentage_pricing:
                type: boolean
                deprecated: false
                description: |
                  Indicates whether the line item is percentage-based.
                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: 2000
                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
                  * 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
                enum:
                - adhoc
                - plan_item_price
                - addon_item_price
                - charge_item_price
                example: null
              tax_exempt_reason:
                type: string
                deprecated: false
                description: |
                  The reason due to which the line item price/amount is exempted from tax.

                  * zero_value_item - 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.
                  * reverse_charge - If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only
                  * tax_not_configured - If tax is not enabled for the site
                  * high_value_physical_goods - 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
                  * tax_not_configured_external_provider - If the tax is not configured for the country in 3rd party tax provider.
                  * customer_exempt - If the Customer is marked as Tax exempt
                  * region_non_taxable - 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
                  * product_exempt - If the Plan or Addon is marked as Tax exempt
                  * zero_rated - If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item
                  * export -
                    You are not registered for tax in the customer's region. This is also the reason code when both `billing_address`
                    and `shipping_address`
                    have not been provided for the customer and subscription respectively
                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
              proration_mode:
                type: string
                deprecated: false
                enum:
                - reset
                - delta
                - service_period_revision
                - adjusted_term
                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: |
                  The price of the tier if the charge model is a `stairtstep`
                  pricing , or the price of each unit in the tier if the charge model is `tiered`
                  /`volume`
                  pricing.
                minimum: 0
                example: null
              starting_unit_in_decimal:
                type: string
                deprecated: false
                description: |
                  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 `ending_unit_in_decimal`
                  of the next lower tier. Returned only when the `line_items.pricing_model`
                  is `tiered`
                  , `volume`
                  or `stairstep`
                  and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 33
                example: null
              ending_unit_in_decimal:
                type: string
                deprecated: false
                description: |
                  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 `starting_unit_in_decimal`
                  of the next higher tier. Returned only when the `line_items.pricing_model`
                  is `tiered`
                  , `volume`
                  or stairstep and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 33
                example: null
              quantity_used_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the quantity purchased from this tier. Returned when the `line_item`
                  is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 33
                example: null
              unit_amount_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the per-unit price for the tier when the `pricing_model`
                  is `tiered`
                  or `volume`.
                  When the `pricing_model`
                  is `stairstep`
                  , it is the decimal representation of the total price for `line_item`.
                  The value is in major units of the currency. Returned when the `line_item`
                  is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 40
                example: null
              pricing_type:
                type: string
                deprecated: false
                description: |
                  Pricing type for the tier.

                  * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                  * flat_fee -
                    Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                    pricing model, `pricing_type`
                    will be set to `flat_fee`
                    by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                  * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                enum:
                - per_unit
                - flat_fee
                - package
                example: null
              package_size:
                type: integer
                format: int32
                deprecated: false
                description: |
                  Package size for the tier when pricing type is `package`.
                  Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                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: |
                  The type of deduction and the amount to which it is applied.

                  * prorated_credits -
                    The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`
                    is `null`
                    in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)
                    .
                  * document_level_coupon -
                    The deduction is due to a coupon applied to the invoice `sub_total`.
                    The coupon `id`
                    is available as `entity_id`
                    .
                  * promotional_credits -
                    The deduction is due to a [promotional credit](/docs/api/promotional_credits)
                    applied to the invoice. The `entity_id`
                    is `null`
                    in this case.
                  * item_level_coupon -
                    The deduction is due to a coupon applied to a line item of the invoice. The coupon `id`
                    is available as `entity_id`
                    .
                  * document_level_discount -
                    The deduction is due to a [discount](/docs/api/discounts)
                    applied to the invoice `sub_total`.
                    The discount `id`
                    is available as the `entity_id`.
                  * item_level_discount -
                    The deduction is due to a [discount](/docs/api/discounts)
                    applied to a line item of the invoice. The discount `id`
                    is available as the `entity_id`.
                enum:
                - item_level_coupon
                - document_level_coupon
                - promotional_credits
                - prorated_credits
                - item_level_discount
                - document_level_discount
                example: null
              coupon_id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              entity_id:
                type: string
                deprecated: false
                description: |
                  When the deduction is due to a `coupon`
                  or a [discount](/docs/api/discounts)
                  , then this is the `id`
                  of the coupon or discount.
                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: |
                  The unique id of the line item that this deduction is for. Is required when `discounts[entity_type]`
                  is `item_level_coupon`
                  or `document_level_coupon`
                  .
                maxLength: 40
                example: null
              entity_type:
                type: string
                deprecated: false
                description: |
                  The type of deduction and the amount to which it is applied.

                  * prorated_credits -
                    The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`
                    is `null`
                    in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)
                    .
                  * item_level_coupon -
                    The deduction is due to a coupon applied to line item. The coupon `id`
                    is passed as `entity_id`
                    .
                  * item_level_discount -
                    The deduction is due to a [discount](/docs/api/discounts)
                    applied to a line item of the invoice. The discount `id`
                    is available as the `entity_id`.
                  * document_level_coupon -
                    The deduction is due to a coupon applied to the invoice `sub_total`.
                    The coupon id is passed as `entity_id`
                    .
                  * promotional_credits -
                    The deduction is due to a [promotional credit](/docs/api/promotional_credits)
                    applied to the invoice.
                  * document_level_discount -
                    The deduction is due to a [discount](/docs/api/discounts)
                    applied to the invoice `sub_total`.
                    The discount `id`
                    is available as the `entity_id`.
                enum:
                - item_level_coupon
                - document_level_coupon
                - promotional_credits
                - prorated_credits
                - item_level_discount
                - document_level_discount
                example: null
              discount_type:
                type: string
                deprecated: false
                description: |
                  The type of discount that is applied to the line item. Relevant only when `discounts[entity_type]`
                  is one of `item_level_discount`
                  , `item_level_coupon`
                  , `document_level_discount`
                  , or `document_level_coupon`

                  * percentage - when percentage is applied as discount
                  * fixed_amount - when amount is applied as discount
                enum:
                - fixed_amount
                - percentage
                example: null
              entity_id:
                type: string
                deprecated: false
                description: |
                  When the deduction is due to a `coupon`
                  or a [discount](/docs/api/discounts)
                  , then this is the `id`
                  of the coupon or discount.
                maxLength: 100
                example: null
              coupon_set_code:
                type: string
                deprecated: false
                description: |
                  The [coupon code](/docs/api/coupon_codes/coupon_code-object#code)
                  , if applicable, used to provide the discount. The [coupon.id](/docs/api/coupons/coupon-object#id)
                  is available in `entity_id`
                  .
                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: |
                The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
                without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                as `AZ`
                (not `US-AZ`
                ). For Tamil Nadu (India), set as `TN`
                (not `IN-TN`
                ). For British Columbia (Canada), set as `BC`
                (not `CA-BC`
                ). For Dubai (UAE), set as `DU`
                (not `AE-DU`
                ).
              maxLength: 50
              example: null
            state:
              type: string
              deprecated: false
              description: |
                The state/province name.
              maxLength: 50
              example: null
            country:
              type: string
              deprecated: false
              description: "The billing address country of the customer. Must be one\
                \ of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                .\n\n**Note**:\nIf you enter an invalid country code, the system will\
                \ return an error.  \n**Brexit**\n\nIf you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                \ the Brexit configuration, then `XI` (the code for **United Kingdom\
                \ - Northern Ireland**) is available as an 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://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: |
                The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
                without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                as `AZ`
                (not `US-AZ`
                ). For Tamil Nadu (India), set as `TN`
                (not `IN-TN`
                ). For British Columbia (Canada), set as `BC`
                (not `CA-BC`
                ). For Dubai (UAE), set as `DU`
                (not `AE-DU`
                ).
              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 country of the customer. Must be one\
                \ of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                .\n\n**Note**:\nIf you enter an invalid country code, the system will\
                \ return an error.  \n**Brexit**\n\nIf you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                \ the Brexit configuration, then `XI` (the code for **United Kingdom\
                \ - Northern Ireland**) is available as an 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://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
      description: "Overview\n--------\n\nThe quote entitlement object represents\
        \ the entitlement a [quote](/docs/api/quotes) holds for a [feature](/docs/api/features).\
        \ A quote can have several quote entitlements, each tied to a specific feature\
        \ and to an entity on the quote (such as a plan price, addon price, or charge\
        \ price).\n\nHow quote entitlements are determined\n-------------------------------------\n\
        \nQuote entitlements are based on the [entitlements](/docs/api/entitlements)\
        \ linked to the [item prices](/docs/api/item_prices) on the quote. If an item\
        \ price lacks an entitlement record for a particular feature, Chargebee considers\
        \ the entitlement (when available) of its parent [item](/docs/api/items).\n\
        \nYou can further customize entitlements by passing `entitlement_overrides`\
        \ when creating or editing item-based quotes. When an entitlement has been\
        \ explicitly overridden on the quote, `is_overridden` is `true` and the entitlement\
        \ takes on the override `value`.\n\nThe method used to derive entitlement\
        \ levels follows the same rules determined by the feature [type](/docs/api/features/feature-object#type)\
        \ as described for [subscription entitlements](/docs/api/subscription_entitlements).\n\
        \nUse the [List Quote Entitlements](/docs/api/quote_entitlements/list-quote-entitlements)\
        \ API to retrieve the entitlements associated with a quote.  \n**Note**\n\
        Applicable only when Chargebee CPQ and Entitlements are enabled. To request\
        \ access, 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"
      properties:
        entity_id:
          type: string
          deprecated: false
          description: |
            The `id` of the entity on the quote whose entitlement this record represents.
          maxLength: 100
          example: null
        entity_type:
          type: string
          deprecated: false
          description: |
            The type of the entity on the quote for which this entitlement applies.

            * charge_price - Indicates that the entity is an `item_price` with [`item_type`](/docs/api/item_prices/item-price-object#item_type) set to `charge`.
            * addon_price - Indicates that the entity is an `item_price` with [`item_type`](/docs/api/item_prices/item-price-object#item_type) set to `addon`.
            * plan_price - Indicates that the entity is an `item_price` with [`item_type`](/docs/api/item_prices/item-price-object#item_type) set to `plan`.
          enum:
          - plan_price
          - addon_price
          - charge_price
          example: null
        feature_id:
          type: string
          deprecated: false
          description: |
            The unique identifier of the [feature](/docs/api/features)
            .
          maxLength: 50
          example: null
        value:
          type: string
          deprecated: false
          description: |
            The level of entitlement that the quote entity has towards the feature. The possible values depend on the value of `feature.type`
            :

            * When `feature.type` is `custom`: The value can be any one of `levels[].value`.

            * When `feature.type` is `switch`: This value is `true` when the feature is available; it is `false` when the feature is unavailable.

            * When `feature.type` is `quantity`:

            * When `levels[].is_unlimited` is not `true`: The value can be any one of `levels[].value`.

            * When `levels[].is_unlimited` is `true`: The value can also be any one of `levels[].value` or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.

            * When `feature.type` is `range`:

            * When `levels[].is_unlimited` is not `true`: The value can be any whole number between `levels[0].value` and `levels[1].value` (inclusive).

            * When `levels[].is_unlimited` is `true`: The value can be any whole number equal to or greater than `levels[0].value` or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.

            **See also:**
            [How quote entitlements are determined](/docs/api/quote_entitlements).
          maxLength: 50
          example: null
        is_enabled:
          type: boolean
          default: true
          deprecated: false
          description: |
            Indicates whether the entitlement for the feature is enabled for the entity on the quote.
          example: null
        start_date:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Start date (UTC timestamp) of this entitlement on the quote. Used with `end_date` for ramp-scoped entitlements.
          example: null
        end_date:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            End date (UTC timestamp) of this entitlement on the quote. Used with `start_date` for ramp-scoped entitlements.
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this quote entitlement record was created.
          example: null
        modified_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this quote entitlement record was last modified.
          example: null
        is_overridden:
          type: boolean
          deprecated: false
          description: |
            Indicates whether the entitlement held by the quote entity for the feature is overridden via an `entitlement_overrides` record on the quote.
          example: null
        feature_name:
          type: string
          deprecated: false
          description: |
            The [name of the feature](/docs/api/features/feature-object#name)
            .
          maxLength: 50
          example: null
        feature_unit:
          type: string
          deprecated: false
          description: |
            [The unit of measure](/docs/api/features/feature-object#unit)
            for the feature when its `type`
            is either `quantity`
            or `range`
            .
          maxLength: 50
          example: null
        feature_type:
          type: string
          deprecated: false
          description: |
            Specifies the [type of the feature](/docs/api/features/feature-object#type)
            associated with the granted quote entitlement.
          maxLength: 50
          example: null
        name:
          type: string
          deprecated: false
          description: |
            The display name of the entitlement level that the quote entity holds for the feature. It is derived based on the `type`
            of feature as follows:

            * When `feature.type` is `range` or `quantity`: the `name` is the space-separated concatenation of `value` and the pluralized form of `feature_unit`. For example, if `value` is `20` and `feature_unit` is `user`, then `name` becomes `20 users`.
            * When `feature.type` is `custom`: the `name` is the same as `value`.
            * When `feature.type` is `switch`: `name` is set to `Available` when `value` is `true`; it's set to `Not Available` when `value` is `false`.
          maxLength: 50
          example: null
        metered:
          type: boolean
          deprecated: false
          description: |
            Indicates if the feature is a metered feature.
          example: null
      required:
      - created_at
      - entity_id
      - entity_type
      - feature_id
      - is_enabled
      - modified_at
      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/invoices/invoice-object#line_items_quantity)
                  which is represented by this line item. For
                  `metered`
                  line items, this value is updated from
                  [usages](/docs/api/usages)
                  once when the invoice is generated as
                  `pending`
                  and finally when the invoice is
                  [closed](/docs/api/invoices/close-a-pending-invoice)
                  .
                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/2.0/plans.html#pricing-models)
                  for this item price.

                  * 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: |
                  The decimal representation of the unit amount of the `line_item`.
                  The value is in major units of the currency. Returned when the `line_item`
                  is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 39
                example: null
              quantity_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the quantity of this line_item. Returned when the `line_item`
                  is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 33
                example: null
              amount_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the amount for the `line_item`
                  , in major units of the currency. Typically equals to `unit_amount_in_decimal`
                  x `quantity_in_decimal`.
                  Returned when [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                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: 2000
                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:
                - adhoc
                - plan_item_price
                - addon_item_price
                - charge_item_price
                example: null
              tax_exempt_reason:
                type: string
                deprecated: false
                description: |
                  The reason due to which the line item price/amount is exempted from tax.

                  * reverse_charge - If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only
                  * tax_not_configured - If tax is not enabled for the site
                  * high_value_physical_goods - 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
                  * product_exempt - If the Plan or Addon is marked as Tax exempt
                  * zero_rated - If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item
                  * customer_exempt - If the Customer is marked as Tax exempt
                  * region_non_taxable - 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
                  * export -
                    You are not registered for tax in the customer's region. This is also the reason code when both `billing_address`
                    and `shipping_address`
                    have not been provided for the customer and subscription respectively
                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
              proration_mode:
                type: string
                deprecated: false
                enum:
                - reset
                - delta
                - service_period_revision
                - adjusted_term
                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: |
                  The type of deduction and the amount to which it is applied.

                  * item_level_coupon -
                    The deduction is due to a coupon applied to a line item of the invoice. The coupon `id`
                    is available as `entity_id`
                    .
                  * prorated_credits -
                    The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`
                    is `null`
                    in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)
                    .
                  * document_level_coupon -
                    The deduction is due to a coupon applied to the invoice `sub_total`.
                    The coupon `id`
                    is available as `entity_id`
                    .
                  * document_level_discount -
                    The deduction is due to a [discount](/docs/api/discounts)
                    applied to the invoice `sub_total`.
                    The discount `id`
                    is available as the `entity_id`.
                  * item_level_discount -
                    The deduction is due to a [discount](/docs/api/discounts)
                    applied to a line item of the invoice. The discount `id`
                    is available as the `entity_id`.
                  * promotional_credits -
                    The deduction is due to a [promotional credit](/docs/api/promotional_credits)
                    applied to the invoice. The `entity_id`
                    is `null`
                    in this case.
                enum:
                - item_level_coupon
                - document_level_coupon
                - promotional_credits
                - prorated_credits
                - item_level_discount
                - document_level_discount
                example: null
              coupon_id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              entity_id:
                type: string
                deprecated: false
                description: |
                  When the deduction is due to a
                  `coupon`
                  or a
                  [discount](/docs/api/discounts)
                  , then this is the
                  `id`
                  of the coupon or discount.
                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: |
                  The unique id of the line item that this deduction is for. Is required when `discounts[entity_type]`
                  is `item_level_coupon`
                  or `document_level_coupon`
                  .
                maxLength: 40
                example: null
              entity_type:
                type: string
                deprecated: false
                description: |
                  The type of deduction and the amount to which it is applied.

                  * document_level_coupon -
                    The deduction is due to a coupon applied to the invoice `sub_total`.
                    The coupon id is passed as `entity_id`
                    .
                  * prorated_credits -
                    The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`
                    is `null`
                    in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)
                    .
                  * item_level_coupon -
                    The deduction is due to a coupon applied to line item. The coupon `id`
                    is passed as `entity_id`
                    .
                  * item_level_discount -
                    The deduction is due to a [discount](/docs/api/discounts)
                    applied to a line item of the invoice. The discount `id`
                    is available as the `entity_id`.
                  * promotional_credits -
                    The deduction is due to a [promotional credit](/docs/api/promotional_credits)
                    applied to the invoice.
                  * document_level_discount -
                    The deduction is due to a [discount](/docs/api/discounts)
                    applied to the invoice `sub_total`.
                    The discount `id`
                    is available as the `entity_id`.
                enum:
                - item_level_coupon
                - document_level_coupon
                - promotional_credits
                - prorated_credits
                - item_level_discount
                - document_level_discount
                example: null
              discount_type:
                type: string
                deprecated: false
                description: |
                  The type of discount that is applied to the line item. Relevant only when `discounts[entity_type]`
                  is one of `item_level_discount`
                  , `item_level_coupon`
                  , `document_level_discount`
                  , or `document_level_coupon`

                  * percentage - when percentage is applied as discount
                  * fixed_amount - when amount is applied as discount
                enum:
                - fixed_amount
                - percentage
                example: null
              entity_id:
                type: string
                deprecated: false
                description: |
                  When the deduction is due to a
                  `coupon`
                  or a
                  [discount](/docs/api/discounts)
                  , then this is the
                  `id`
                  of the coupon or discount.
                maxLength: 100
                example: null
              coupon_set_code:
                type: string
                deprecated: false
                description: |
                  The [coupon code](/docs/api/coupon_codes/coupon_code-object#code)
                  , if applicable, used to provide the discount. The [coupon.id](/docs/api/coupons/coupon-object#id)
                  is available in `entity_id`
                  .
                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
    QuoteType:
      type: string
      deprecated: true
      enum:
      - amendment
      - renewal
      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: |
        When the
        [operation_type](/docs/api/quotes/quote-object#operation_type)
        of a
        `quote`
        is
        `onetime_invoice`
        , the
        `quoted_charges`
        resource contains the details of the invoice that is eventually created once the quote is invoiced. It is always returned along with the quote.
      properties:
        charges:
          type: array
          deprecated: false
          description: |
            Provides details of all the ad-hoc charges
            [added to the quote](/docs/api/quotes/create-a-quote-for-charge-and-charge-items)
            .
          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
              entity_description:
                type: string
                deprecated: false
                maxLength: 2000
                example: null
              service_period_in_days:
                type: integer
                format: int32
                deprecated: false
                description: |
                  Specifies the service period of the charge in days. When the quote is converted, the [invoice.line_item.date_from](/docs/api/invoices/invoice-object#line_items)
                  is set to current date/time and `invoice.line_item.date_to`
                  is set to `service_period_in_days`
                  ahead of `date_from`
                  .
                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
                  * 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
              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
        invoice_items:
          type: array
          deprecated: false
          description: |
            Details of individual [item prices](/docs/api/item_prices)
            that are part of this subscription
          items:
            type: object
            deprecated: false
            properties:
              item_price_id:
                type: string
                deprecated: false
                description: |
                  A unique ID for your system to identify the item price.
                maxLength: 100
                example: null
              quantity:
                type: integer
                format: int32
                deprecated: false
                description: |
                  Item price quantity
                minimum: 1
                example: null
              quantity_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)
                  is enabled.
                maxLength: 33
                example: null
              unit_price:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The price or per-unit-price of the item price. By default, it is the [value set](/docs/api/item_prices/item_price-object#price)
                  for the `item_price`.
                  This is only applicable when the `pricing_model`
                  of the `item_price`
                  is `flat_fee`
                  or `per_unit`.
                  The value depends on the [type of currency](/docs/api/getting-started)
                  .
                minimum: 0
                example: null
              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/getting-started)
                  is enabled.
                maxLength: 39
                example: null
              description:
                type: string
                deprecated: false
                maxLength: 250
                example: null
              entity_description:
                type: string
                deprecated: false
                maxLength: 2000
                example: null
              service_period_days:
                type: integer
                format: int32
                deprecated: false
                description: |
                  Defines service period of the item in days from the day of charge.
                maximum: 730
                minimum: 1
                example: null
            required:
            - item_price_id
            example: null
          example: null
        item_tiers:
          type: array
          deprecated: false
          description: |
            The pricing details of `subscription_items`
            which have `pricing_model`
            as `tiered`
            , `volume`
            or `stairstep`.
            [Learn more](https://www.chargebee.com/docs/plans.html#pricing-models)
            about pricing models.
          items:
            type: object
            deprecated: false
            properties:
              item_price_id:
                type: string
                deprecated: false
                description: |
                  The id of the item price to which this tier belongs.
                maxLength: 100
                example: null
              starting_unit:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The lowest value in the quantity tier.
                minimum: 1
                example: null
              ending_unit:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The highest value in the quantity tier.
                example: null
              price:
                type: integer
                format: int64
                default: 0
                deprecated: false
                description: |
                  The per-unit price for the tier when the `pricing_model`
                  is `tiered`
                  or `volume`.
                  The total cost for the item price when the `pricing_model`
                  is `stairstep`.
                  The value is in the minor unit of the currency.
                minimum: 0
                example: null
              starting_unit_in_decimal:
                type: string
                deprecated: false
                description: |
                  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 `ending_unit_in_decimal`
                  of the next lower tier. Returned only when the pricing_model is `tiered`
                  , `volume`
                  or `stairstep`
                  and [multi-decimal pricing](/docs/api/getting-started)
                  is enabled.
                maxLength: 33
                example: null
              ending_unit_in_decimal:
                type: string
                deprecated: false
                description: |
                  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 `starting_unit_in_decimal`
                  of the next higher tier. Returned only when the pricing_model is `tiered`
                  , `volume`
                  or `stairstep`
                  and [multi-decimal pricing](/docs/api/getting-started)
                  is enabled.
                maxLength: 33
                example: null
              price_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the per-unit price for the tier when the `pricing_model`
                  is `tiered`
                  or `volume`.
                  When the `pricing_model`
                  is `stairstep`
                  , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/getting-started)
                  is enabled.
                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
              index:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The index number of the subscription to which the item price is added. Provide a unique number between `0`
                  and `4`
                  (inclusive) for each subscription that is to be created.
                minimum: 0
                example: null
            required:
            - index
            - item_price_id
            - price
            - starting_unit
            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
        discounts:
          type: array
          deprecated: false
          description: |
            List of discounts for the charges in this quote.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  An immutable unique id for the discount. It is always auto-generated.
                maxLength: 50
                example: null
              invoice_name:
                type: string
                deprecated: false
                description: |
                  The name of the discount as it should appear on customer-facing pages and documents such as [invoices](/docs/api/invoices)
                  and [hosted pages](/docs/api/hosted_pages).
                  This is auto-generated based on the `type`
                  , `amount`
                  , and `currency_code`
                  of the discount. For example, it can be `10% off`
                  or `10$ off`
                  .
                maxLength: 100
                example: null
              type:
                type: string
                default: percentage
                deprecated: false
                description: |
                  The type of discount.
                  Possible value are:

                  * offer_quantity -
                    A specified number of units of the item price are offered for free. The number of free units is specified in `quantity`.
                    The `offer_quantity`
                    option is valid only when `apply_on`
                    is set to `each_specified_item`
                    and the [pricing_model](/docs/api/item_prices/item_price-object#pricing_model)
                    of the item price is `per_unit`
                    .
                  * percentage - The specified percentage will be given as discount.
                  * fixed_amount - The specified amount will be given as discount.
                enum:
                - fixed_amount
                - percentage
                - offer_quantity
                example: null
              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
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The value of the discount. [The format of this value](/docs/api/currencies)
                  depends on the kind of currency.
                minimum: 0
                example: null
              quantity:
                type: integer
                format: int32
                deprecated: false
                description: |
                  Specifies the number of free units provided for the item, without affecting the total quantity sold. This parameter is applicable only when `discount.type`
                  is `offer_quantity`.
                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 discount. This is only applicable when `discount.type`
                  is `fixed_amount`
                  .
                maxLength: 3
                example: null
              apply_on:
                type: string
                deprecated: false
                description: |
                  The amount on the invoice to which the discount is applied.

                  * invoice_amount -
                    The discount is applied to the invoice `sub_total`
                    .
                  * specific_item_price -
                    The discount is applied to the `invoice.line_item.amount`
                    that corresponds to the item price specified by `item_price_id`
                    .
                enum:
                - invoice_amount
                - specific_item_price
                example: null
              item_price_id:
                type: string
                deprecated: false
                description: |
                  The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                  in the subscription to which the discount is to be applied. Relevant only when `apply_on`
                  = `specific_item_price`.
                maxLength: 100
                example: null
              created_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Timestamp indicating when this discount is created.
                example: null
              coupon_id:
                type: string
                deprecated: false
                description: "Used to uniquely identify the coupon in your website/application\
                  \ and to integrate with Chargebee.  \n**Note:**\n\nWhen the coupon\
                  \ ID contains a special character; for example: `#`, the API returns\
                  \ an error. Make sure that you [encode](https://www.urlencoder.org/)\
                  \ the coupon ID in the path parameter before making an API call.\n"
                maxLength: 100
                example: null
              index:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The index number of the subscription to which the item price is added. Provide a unique number between `0`
                  and `4`
                  (inclusive) for each subscription that is to be created.
                minimum: 0
                example: null
            required:
            - apply_on
            - coupon_id
            - created_at
            - id
            - index
            - type
            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
      description: "When a [quote](/docs/api/quotes) is created, it generates the\
        \ `quoted_ramps` resource. This captures most of the details of the [ramps](/docs/api/ramps)\
        \ that would eventually be created once the quote is invoiced. This resource\
        \ is returned along with the quote for most of the associated operations.\
        \  \n**Note**\nApplicable only when Chargebee CPQ and [Subscription Ramps](/docs/api/ramps)\
        \ are enabled. To request access, 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"
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        line_items:
          type: array
          deprecated: false
          description: |
            Provides details of the individual line items in the subscription. If the subscription includes ramps, this array contains line items from all ramps.
          items:
            type: object
            deprecated: false
            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: |
                  The type of item. There must be one and only one item of type `plan`
                  in this list.

                  * charge - Charge
                  * addon - Addon
                  * plan - Plan
                enum:
                - plan
                - addon
                - charge
                example: null
              quantity:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The quantity of the item purchased
                minimum: 1
                example: null
              quantity_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)
                  is enabled.
                maxLength: 33
                example: null
              unit_price:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The price/per unit price of the item. When not provided, [the value set](/docs/api/item_prices/item-price-object)
                  for the item price is used. This is only applicable when the `pricing_model`
                  of the item price is `flat_fee`
                  or `per_unit`.
                  Also, it is only allowed when [price overriding](https://www.chargebee.com/docs/price-override.html)
                  is enabled for the site. The value depends on the type of currency.
                minimum: 0
                example: null
              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/getting-started)
                  is enabled.
                maxLength: 39
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The total amount for the item as determined from `unit_price`
                  , `free_quantity`
                  , `quantity`
                  and `item_tiers`
                  as applicable. The value depends on the [type of currency](/docs/api/quoted_ramps)
                  .
                minimum: 0
                example: null
              amount_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the total amount for the item, in major units of the currency. Always returned when [multi-decimal pricing](/docs/api/getting-started)
                  is enabled.
                maxLength: 39
                example: null
              billing_period:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The interval between consecutive billing cycles for the subscription item. The interval is measured in the units defined by `billing_period_unit`
                  .
                minimum: 1
                example: null
              billing_period_unit:
                type: string
                deprecated: false
                description: |
                  The unit of measurement used to define the `billing_period`
                  for the subscription item.

                  * week - A period of 7 days.
                  * year - A period of 1 calendar year.
                  * day - A period of 24 hours.
                  * month - A period of 1 calendar month.
                enum:
                - day
                - week
                - month
                - year
                example: null
              free_quantity:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The `free_quantity`
                  of the plan-item as [specified](/docs/api/item_prices)
                  for the item price.
                minimum: 0
                example: null
              free_quantity_in_decimal:
                type: string
                deprecated: false
                description: |
                  The `free_quantity_in_decimal`
                  as set for the item price. Returned for quantity-based item prices when [multi-decimal pricing](/docs/api/getting-started)
                  is enabled.
                maxLength: 33
                example: null
              billing_cycles:
                type: integer
                format: int32
                deprecated: false
                description: |
                  For the plan-item price:
                  the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then [the value set](/docs/api/item_prices/item-price-object)
                  for the plan-item price is used.

                  For addon-item prices:
                  If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)
                  are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then [the value set under attached addons](/docs/api/attached_items/attached-item-object)
                  is used. Further, if that value is not provided, then [the value set for the addon-item price](/docs/api/item_prices/item-price-object)
                  is used.
                minimum: 0
                example: null
              service_period_days:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The service period of the item in days from the day of charge.
                maximum: 730
                minimum: 1
                example: null
              charge_on_event:
                type: string
                deprecated: false
                description: |
                  When `charge_on_option`
                  option is set to `on_event`
                  , this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.

                  * plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                  * subscription_trial_start - the time when the trial period of the subscription begins.
                  * contract_termination -
                    when a contract term is [terminated](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option)
                    .
                  * subscription_activation -
                    the moment a subscription enters an `active`
                    or `non-renewing`
                    state. Also includes reactivations of canceled subscriptions.
                  * subscription_creation - the time of creation of the subscription.
                enum:
                - subscription_creation
                - subscription_trial_start
                - plan_activation
                - subscription_activation
                - contract_termination
                example: null
              charge_once:
                type: boolean
                deprecated: false
                description: |
                  Indicates if the charge-item is to be charged only once or each time the `charge_on_event`
                  occurs. This parameter only applies to charge-items.
                example: null
              charge_on_option:
                type: string
                deprecated: false
                description: |
                  Indicates when the charge-item is to be charged. This parameter only applies to charge-items.

                  * on_event -
                    The item is charged at the occurrence of the event specified as `charge_on_event`
                    .
                  * immediately - The item is charged immediately on being added to the subscription.
                enum:
                - immediately
                - on_event
                example: null
              start_date:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Specifies the start date for the item price in the subscription. The period of the item price, determined by the `start_date` and `end_date`, specifies the [ramp](/docs/api/quoted_ramps) it belongs to.
                example: null
              end_date:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Specifies the end date for the item price in the subscription. The period of the item price, determined by the `start_date` and `end_date`, specifies the [ramp](/docs/api/quoted_ramps) it belongs to.
                example: null
              ramp_tier_id:
                type: string
                deprecated: false
                description: |
                  The index or identifier of the [ramp](/docs/api/ramps) to which the item price belongs. This index is used to map `item_tier[i]` values to the correct ramp, as the target `item_price` of an `item_tier` may be part of multiple ramps.
                maxLength: 105
                example: null
              discount_per_billing_cycle:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Specifies the discount amount applied to a line item per billing cycle. This includes both item-level and invoice-level discounts.
                  **Example:** Consider a monthly quote that includes a plan, an addon, a $50 discount on the plan, and an additional $100 invoice-level discount. In this case, `discount_per_billing_cycle` for the plan would be ($50 + $100 ÷ 2) = $100.
                minimum: 0
                example: null
              discount_per_billing_cycle_in_decimal:
                type: string
                deprecated: false
                description: |
                  Specifies the discount amount applied to a line item per billing cycle, in decimal format. The value is expressed in the major currency units. This attribute is available only when [Multi-Decimal Pricing](/docs/api/currencies) is enabled.
                  **See also:** `discount_per_billing_cycle`.
                maxLength: 39
                example: null
              item_level_discount_per_billing_cycle:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Specifies the item-level discount amount applied to a line item per billing cycle. This does not include invoice-level discounts.
                  **Example:** Consider a monthly quote that includes a plan, an addon, a $50 discount on the plan, and an additional $100 invoice-level discount. In this case, `item_level_discount_per_billing_cycle` for the plan would be $50.
                minimum: 0
                example: null
              item_level_discount_per_billing_cycle_in_decimal:
                type: string
                deprecated: false
                description: |
                  Specifies the item-level discount amount applied to a line item per billing cycle, in decimal format. The value is expressed in the major currency units. This attribute is available only when [Multi-Decimal Pricing](/docs/api/currencies) is enabled.
                  **See also:** `item_level_discount_per_billing_cycle`.
                maxLength: 39
                example: null
              amount_per_billing_cycle:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Specifies the amount for this line item before discounts.
                  \*\*Example:\*\*Consider a monthly quote that includes a $500 plan, an addon, a $50 discount on the plan, and an additional $100 invoice-level discount. In this case, `amount_per_billing_cycle` for the plan would be $500.
                minimum: 0
                example: null
              amount_per_billing_cycle_in_decimal:
                type: string
                deprecated: false
                description: |
                  Specifies the amount for this line item before discounts, in decimal format. The value is expressed in the major currency units. This attribute is available only when [Multi-Decimal Pricing](/docs/api/currencies) is enabled.
                  **See also:** `amount_per_billing_cycle`.
                maxLength: 39
                example: null
              net_amount_per_billing_cycle:
                type: integer
                format: int64
                deprecated: false
                description: |
                  Specifies the amount for this line item after discounts.
                  **Example:** Consider a monthly quote that includes a $500 plan, an addon, a $50 discount on the plan, and an additional $100 invoice-level discount. In this case, `net_amount_per_billing_cycle` for the plan would be ($500 - ($50 + $100 ÷ 2)) = $400.
                minimum: 0
                example: null
              net_amount_per_billing_cycle_in_decimal:
                type: string
                deprecated: false
                description: |
                  Specifies the amount for this line item after discounts, in decimal format. The value is expressed in the major currency units. This attribute is available only when [Multi-Decimal Pricing](/docs/api/currencies) is enabled.
                  **See also:** `net_amount_per_billing_cycle`.
                maxLength: 39
                example: null
              description:
                type: string
                deprecated: false
                maxLength: 2000
                example: null
            required:
            - item_price_id
            - item_type
            example: null
          example: null
        discounts:
          type: array
          deprecated: false
          description: |
            List of discounts for this quoted subscription.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  An immutable unique id for the discount. It is always auto-generated.
                maxLength: 50
                example: null
              invoice_name:
                type: string
                deprecated: false
                description: |
                  The name of the discount as it should appear on customer-facing pages and documents such as [invoices](/docs/api/invoices)
                  and [hosted pages](/docs/api/hosted_pages).
                  This is auto-generated based on the `type`
                  , `amount`
                  , and `currency_code`
                  of the discount. For example, it can be `10% off`
                  or `10$ off`
                  .
                maxLength: 100
                example: null
              type:
                type: string
                default: percentage
                deprecated: false
                description: |
                  The type of discount.
                  Possible value are:

                  * fixed_amount - The specified amount will be given as discount.
                  * percentage - The specified percentage will be given as discount.
                enum:
                - fixed_amount
                - percentage
                example: null
              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
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The value of the discount. [The format of this value](/docs/api/currencies)
                  depends on the kind of currency.
                minimum: 0
                example: null
              duration_type:
                type: string
                default: forever
                deprecated: false
                description: |
                  Specifies the time duration for which this discount is attached to the subscription.

                  * forever -
                    The discount is attached to the subscription and applied on the invoices till it is [explicitly removed](/docs/api/subscriptions/update-subscription-for-items#discounts_operation_type)
                    .
                  * 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 `period`
                    and `period_unit`
                    .
                  * one_time -
                    The discount stays attached to the subscription till it is applied on an invoice **once**.
                    It is removed after that from the subscription.
                enum:
                - one_time
                - forever
                - limited_period
                example: null
              entity_type:
                type: string
                deprecated: false
                description: |
                  The type of deduction and the amount it applies to.

                  * document_level_coupon - The deduction comes from a [coupon](/docs/api/coupons) applied at the invoice level. The coupon id is available in the `entity_id` attribute.
                  * item_level_coupon - The deduction comes from a [coupon](/docs/api/coupons) applied to a specific line item. The coupon `id` is available in the `entity_id` attribute.
                  * item_level_discount - The deduction comes from a [discount](/docs/api/discounts) applied to a specific line item. The discount `id` is available in the `entity_id` attribute.
                  * document_level_discount - The deduction comes from a [discount](/docs/api/discounts) applied at the invoice level. The discount `id` is available in the `entity_id` attribute.
                enum:
                - item_level_coupon
                - document_level_coupon
                - item_level_discount
                - document_level_discount
                example: null
              entity_id:
                type: string
                deprecated: false
                description: |
                  When the deduction results from a [coupon](/docs/api/coupons) or a [discount](/docs/api/discounts), this attribute contains the `id` of that coupon or discount.
                maxLength: 100
                example: null
              period:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The duration of time for which the discount is attached to the subscription, in `period_units`.
                  Applicable only when `duration_type`
                  is `limited_period`.
                minimum: 1
                example: null
              period_unit:
                type: string
                deprecated: false
                description: |
                  The unit of time for `period`.
                  Applicable only when `duration_type`
                  is `limited_period`.

                  * day - A period of 24 hours.
                  * week - A period of 7 days.
                  * month - A period of 1 calendar month.
                  * year - A period of 1 calendar year.
                enum:
                - day
                - week
                - month
                - year
                example: null
              included_in_mrr:
                type: boolean
                deprecated: false
                description: |
                  The discount is included in MRR calculations for your site. This attribute is only applicable when `duration_type`
                  is `one_time`
                  and when the [feature is enabled](https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation)
                  in Chargebee. Also, If the [site-level setting](https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation)
                  is to exclude one-time discounts from MRR calculations, this value is always returned `false`.
                example: null
              apply_on:
                type: string
                deprecated: false
                description: |
                  The amount on the invoice to which the discount is applied.

                  * invoice_amount -
                    The discount is applied to the invoice `sub_total`
                    .
                  * specific_item_price -
                    The discount is applied to the `invoice.line_item.amount`
                    that corresponds to the item price specified by `item_price_id`
                    .
                enum:
                - invoice_amount
                - specific_item_price
                example: null
              item_price_id:
                type: string
                deprecated: false
                description: |
                  The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                  in the subscription to which the discount is to be applied. Relevant only when `apply_on`
                  = `specific_item_price`.
                maxLength: 100
                example: null
              created_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Timestamp indicating when this discount is created.
                example: null
              updated_at:
                type: integer
                format: unix-time
                deprecated: false
                example: null
              start_date:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Specifies the start date for the discount. The period of the discount, as specified by the `start_date` and `end_date` determines the [ramp(s)](/docs/api/quoted_ramps) it will be part of.
                example: null
              end_date:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Specifies the end date for the discount. The period of the discount, as specified by the `start_date` and `end_date` determines the [ramp(s)](/docs/api/quoted_ramps) it will be part of.
                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
          description: |
            List of item tier.
          items:
            type: object
            deprecated: false
            properties:
              item_price_id:
                type: string
                deprecated: false
                description: |
                  The id of the item price to which this tier belongs.
                maxLength: 100
                example: null
              starting_unit:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The lowest value in the quantity tier.
                minimum: 1
                example: null
              ending_unit:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The highest value in the quantity tier.
                example: null
              price:
                type: integer
                format: int64
                default: 0
                deprecated: false
                description: |
                  The per-unit price for the tier when the `pricing_model`
                  is `tiered`
                  or `volume`.
                  The total cost for the item price when the `pricing_model`
                  is `stairstep`.
                  The value is in the minor unit of the currency.
                minimum: 0
                example: null
              starting_unit_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as `ending_unit_in_decimal`
                  of the next lower tier. Returned only when the pricing_model is `tiered`
                  , `volume`
                  or `stairstep`
                  and [multi-decimal pricing](/docs/api/getting-started)
                  is enabled.
                maxLength: 33
                example: null
              ending_unit_in_decimal:
                type: string
                deprecated: false
                description: |
                  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 `starting_unit_in_decimal`
                  of the next higher tier. Returned only when the pricing_model is `tiered`
                  , `volume`
                  or `stairstep`
                  and [multi-decimal pricing](/docs/api/getting-started)
                  is enabled.
                maxLength: 33
                example: null
              price_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the per-unit price for the tier when the `pricing_model`
                  is `tiered`
                  or `volume`.
                  When the `pricing_model`
                  is `stairstep`
                  , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/getting-started)
                  is enabled.
                maxLength: 39
                example: null
              ramp_tier_id:
                type: string
                deprecated: false
                description: |
                  The index or identifier of the [ramp](/docs/api/ramps) to which this tier information belongs. This is a value from the `line_items[i].ramp_tier_id`. Since an item price can be part of multiple subscriptions ramps, this group ID specifies the ramp to which this tier information belongs.
                maxLength: 105
                example: null
              pricing_type:
                type: string
                deprecated: false
                description: |
                  Pricing type for the tier.

                  * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20, consuming 400 units will result in a charge of $80 (4 × $20).
                  * flat_fee -
                    Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                    pricing model, `pricing_type`
                    will be set to `flat_fee`
                    by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                  * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                enum:
                - per_unit
                - flat_fee
                - package
                example: null
              package_size:
                type: integer
                format: int32
                deprecated: false
                description: |
                  Package size for the tier when pricing type is `package`.
                  Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                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: |
        When a [quote](/docs/api/quotes) is created, it generates the `quoted_subscription` 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.
      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
        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
        start_date:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Applicable only when `operation_type`
            of the quote is `create_subscription_for_customer`.
            For subscriptions in the `future`
            `status`
            , 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:

            * Backdating is enabled for subscription creation operations.
            * 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.
            * 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's plan is 2 months and today is 14th April, the `start_date` cannot be earlier than 14th February.
          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
          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/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/currencies)
            is enabled.
          maxLength: 39
          example: null
        changes_scheduled_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |+
            Applicable only when `operation_type`
            of the quote is `change_subscription`.
            When `change_option`
            is set to `specific_date`
            , 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:

            * Backdating must be enabled for subscription change operations.

            * Only the following changes can be backdated:

            * Changes in the recurring items or their prices.

            * Addition of non-recurring items.

            * Subscription `status` is `active`, `cancelled`, or `non_renewing`.

            * 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.

            * The date is on or after `current_term_start`.

            * The date is on or after the last date/time any of the following changes were made:

            * Changes in the recurring items or their prices.

            * Addition of non-recurring items.

            * 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's plan is 2 months and today is 14th April, `changes_scheduled_at` cannot be earlier than 14th February.

          example: null
        change_option:
          type: string
          deprecated: false
          description: |
            Applicable only when `operation_type`
            of the quote is `change_subscription`.
            When the quote is converted, this attribute determines the date/time as of when the subscription change is to be carried out.

            * end_of_term - The change is scheduled to be carried out at the end of the billing cycle of the subscription.
            * specific_date -
              The change is carried out as of `changes_scheduled_at`
              .
            * immediately - The change is carried out immediately upon quote conversion.
          enum:
          - end_of_term
          - specific_date
          - immediately
          example: null
        free_period:
          type: integer
          format: int32
          deprecated: false
          description: "The period of time by which the first term of the subscription\
            \ is extended free of charge. The value is expressed in the time unit\
            \ specified by `free_period_unit`. For example, `3` with `free_period_unit`\
            \ = `month` means 3 free months are added to the first term.  \n**Constraints**\n\
            \n* Applicable only when `operation_type` is `create_subscription_for_customer`.\n\
            * Applicable only when Chargebee CPQ is enabled. To request access, [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"
          minimum: 1
          example: null
        free_period_unit:
          type: string
          deprecated: false
          description: "The time unit for `free_period`.  \n**Constraints**\n\n* Applicable\
            \ only when `operation_type` is `create_subscription_for_customer`.\n\
            * Applicable only when Chargebee CPQ is enabled. To request access, [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\
            \n* week - Charge based on week(s)\n* month - Charge based on month(s)\n\
            * day - Charge based on day(s)\n* year - Charge based on year(s)\n"
          enum:
          - day
          - week
          - month
          - year
          example: null
        contract_term_billing_cycle_on_renewal:
          type: integer
          format: int32
          deprecated: false
          description: |
            Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as `billing_cycles`
            or a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)
            .
          maximum: 100
          minimum: 1
          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
        discounts:
          type: array
          deprecated: false
          description: |
            List of discounts for this quoted subscription.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  An immutable unique id for the discount. It is always auto-generated.
                maxLength: 50
                example: null
              invoice_name:
                type: string
                deprecated: false
                description: |
                  The name of the discount as it should appear on customer-facing pages and documents such as [invoices](/docs/api/invoices)
                  and [hosted pages](/docs/api/hosted_pages).
                  This is auto-generated based on the `type`
                  , `amount`
                  , and `currency_code`
                  of the discount. For example, it can be `10% off`
                  or `10$ off`
                  .
                maxLength: 100
                example: null
              type:
                type: string
                default: percentage
                deprecated: false
                description: |
                  The type of discount.
                  Possible value are:

                  * fixed_amount - The specified amount will be given as discount.
                  * offer_quantity -
                    A specified number of units of the item price are offered for free. The number of free units is specified in `quantity`.
                    The `offer_quantity`
                    option is valid only when `apply_on`
                    is set to `each_specified_item`
                    and the [pricing_model](/docs/api/item_prices/item_price-object#pricing_model)
                    of the item price is `per_unit`
                    .
                  * percentage - The specified percentage will be given as discount.
                enum:
                - fixed_amount
                - percentage
                - offer_quantity
                example: null
              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
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The value of the discount. [The format of this value](/docs/api/currencies)
                  depends on the kind of currency.
                minimum: 0
                example: null
              quantity:
                type: integer
                format: int32
                deprecated: false
                description: |
                  Specifies the number of free units provided for the item, without affecting the total quantity sold. This parameter is applicable only when `discount.type`
                  is `offer_quantity`.
                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 discount. This is only applicable when `discount.type`
                  is `fixed_amount`
                  .
                maxLength: 3
                example: null
              duration_type:
                type: string
                default: forever
                deprecated: false
                description: |
                  Specifies the time duration for which this discount is attached to the subscription.

                  * forever -
                    The discount is attached to the subscription and applied on the invoices till it is [explicitly removed](/docs/api/subscriptions/update-subscription-for-items#discounts_operation_type)
                    .
                  * 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 `period`
                    and `period_unit`
                    .
                  * one_time -
                    The discount stays attached to the subscription till it is applied on an invoice **once**.
                    It is removed after that from the subscription.
                enum:
                - one_time
                - forever
                - limited_period
                example: null
              period:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The duration of time for which the discount is attached to the subscription, in `period_units`.
                  Applicable only when `duration_type`
                  is `limited_period`.
                minimum: 1
                example: null
              period_unit:
                type: string
                deprecated: false
                description: |
                  The unit of time for `period`.
                  Applicable only when `duration_type`
                  is `limited_period`.

                  * day - A period of 24 hours.
                  * week - A period of 7 days.
                  * month - A period of 1 calendar month.
                  * year - A period of 1 calendar year.
                enum:
                - day
                - week
                - month
                - year
                example: null
              included_in_mrr:
                type: boolean
                deprecated: false
                description: |
                  The discount is included in MRR calculations for your site. This attribute is only applicable when `duration_type`
                  is `one_time`
                  and when the [feature is enabled](https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation)
                  in Chargebee. Also, If the [site-level setting](https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation)
                  is to exclude one-time discounts from MRR calculations, this value is always returned `false`.
                example: null
              apply_on:
                type: string
                deprecated: false
                description: |
                  The amount on the invoice to which the discount is applied.

                  * invoice_amount -
                    The discount is applied to the invoice `sub_total`
                    .
                  * specific_item_price -
                    The discount is applied to the `invoice.line_item.amount`
                    that corresponds to the item price specified by `item_price_id`
                    .
                enum:
                - invoice_amount
                - specific_item_price
                example: null
              item_price_id:
                type: string
                deprecated: false
                description: |
                  The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                  in the subscription to which the discount is to be applied. Relevant only when `apply_on`
                  = `specific_item_price`.
                maxLength: 100
                example: null
              created_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Timestamp indicating when this discount is created.
                example: null
              apply_till:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Specifies till when the limited period discount is applicable. This attribute will be sent in the response only for `limited_period`
                  duration type discount.
                example: null
              applied_count:
                type: integer
                format: int32
                deprecated: false
                description: |
                  Specifies the number of times the discount has been applied.
                example: null
              coupon_id:
                type: string
                deprecated: false
                description: "Used to uniquely identify the coupon in your website/application\
                  \ and to integrate with Chargebee.  \n**Note:**\n\nWhen the coupon\
                  \ ID contains a special character; for example: `#`, the API returns\
                  \ an error. Make sure that you [encode](https://www.urlencoder.org/)\
                  \ the coupon ID in the path parameter before making an API call.\n"
                maxLength: 100
                example: null
              index:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The index number of the subscription to which the item price is added. Provide a unique number between `0`
                  and `4`
                  (inclusive) for each subscription that is to be created.
                minimum: 0
                example: null
            required:
            - apply_on
            - coupon_id
            - created_at
            - duration_type
            - id
            - included_in_mrr
            - index
            - type
            example: null
          example: null
        subscription_items:
          type: array
          deprecated: false
          description: |
            Details of individual [item prices](/docs/api/item_prices)
            that are part of this subscription
          items:
            type: object
            deprecated: false
            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: |
                  The type of item. There must be one and only one item of type `plan`
                  in this list.

                  * plan - Plan
                  * charge - Charge
                  * addon - Addon
                enum:
                - plan
                - addon
                - charge
                example: null
              quantity:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The quantity of the item purchased
                minimum: 1
                example: null
              quantity_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)
                  is enabled.
                maxLength: 33
                example: null
              unit_price:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The price/per unit price of the item. When not provided, [the value set](/docs/api/item_prices/item-price-object)
                  for the item price is used. This is only applicable when the `pricing_model`
                  of the item price is `flat_fee`
                  or `per_unit`.
                  Also, it is only allowed when [price overriding](https://www.chargebee.com/docs/price-override.html)
                  is enabled for the site. The value depends on the type of currency. If `changes_scheduled_at`
                  is in the past and a `unit_price`
                  is not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
                minimum: 0
                example: null
              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/getting-started)
                  is enabled.
                maxLength: 39
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The total amount for the item as determined from `unit_price`
                  , `free_quantity`
                  , `quantity`
                  and `item_tiers`
                  as applicable. The value depends on the [type of currency](/docs/api/quoted_subscriptions)
                  .
                minimum: 0
                example: null
              current_term_start:
                type: integer
                format: unix-time
                deprecated: false
                description: "The beginning of the item's current billing period.\
                  \  \n**Note**\nApplicable only when multi-frequency billing is [enabled](https://www.chargebee.com/docs/billing/2.0/subscriptions/multi-frequency-billing#enable-multi-frequency-billing).\n"
                example: null
              current_term_end:
                type: integer
                format: unix-time
                deprecated: false
                description: "The end of the item's current billing period. Chargebee\
                  \ renews the item immediately following this date.  \n**Note**\n\
                  Applicable only when multi-frequency billing is [enabled](https://www.chargebee.com/docs/billing/2.0/subscriptions/multi-frequency-billing#enable-multi-frequency-billing).\n"
                example: null
              next_billing_at:
                type: integer
                format: unix-time
                deprecated: false
                description: "The date or time at when the next billing for the item\
                  \ is scheduled to occur. This typically occurs immediately after\
                  \ `current_term_end`.  \n**Note**\nApplicable only when multi-frequency\
                  \ billing is [enabled](https://www.chargebee.com/docs/billing/2.0/subscriptions/multi-frequency-billing#enable-multi-frequency-billing).\n"
                example: null
              amount_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the total amount for the item, in major units of the currency. Always returned when [multi-decimal pricing](/docs/api/getting-started)
                  is enabled.
                maxLength: 39
                example: null
              billing_period:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The interval between consecutive billing cycles for the subscription item. The interval is measured in the units defined by `billing_period_unit`
                  .
                minimum: 1
                example: null
              billing_period_unit:
                type: string
                deprecated: false
                description: |
                  The unit of measurement used to define the `billing_period`
                  for the subscription item.

                  * year - A period of 1 calendar year.
                  * week - A period of 7 days.
                  * day - A period of 24 hours.
                  * month - A period of 1 calendar month.
                enum:
                - day
                - week
                - month
                - year
                example: null
              free_quantity:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The `free_quantity`
                  of the plan-item as [specified](/docs/api/item_prices)
                  for the item price.
                minimum: 0
                example: null
              free_quantity_in_decimal:
                type: string
                deprecated: false
                description: |
                  The `free_quantity_in_decimal`
                  as set for the item price. Returned for quantity-based item prices when [multi-decimal pricing](/docs/api/getting-started)
                  is enabled.
                maxLength: 33
                example: null
              trial_end:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  The date/time when the trial period of the item ends. Applies to plan-items and--when [enabled](https://www.chargebee.com/docs/2.0/addons-trial.html)
                  --addon-items as well.
                example: null
              billing_cycles:
                type: integer
                format: int32
                deprecated: false
                description: |
                  For the plan-item price:
                  the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then [the value set](/docs/api/item_prices/item-price-object)
                  for the plan-item price is used.

                  For addon-item prices:
                  If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)
                  are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then [the value set under attached addons](/docs/api/attached_items/attached-item-object)
                  is used. Further, if that value is not provided, then [the value set for the addon-item price](/docs/api/item_prices/item-price-object)
                  is used.
                minimum: 0
                example: null
              service_period_days:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The service period of the item in days from the day of charge.
                maximum: 730
                minimum: 1
                example: null
              charge_on_event:
                type: string
                deprecated: false
                description: |
                  When `charge_on_option`
                  option is set to `on_event`
                  , this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.

                  * contract_termination -
                    when a contract term is [terminated](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option)
                    .
                  * subscription_trial_start - the time when the trial period of the subscription begins.
                  * plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                  * subscription_activation -
                    the moment a subscription enters an `active`
                    or `non-renewing`
                    state. Also includes reactivations of canceled subscriptions.
                  * subscription_creation - the time of creation of the subscription.
                enum:
                - subscription_creation
                - subscription_trial_start
                - plan_activation
                - subscription_activation
                - contract_termination
                example: null
              charge_once:
                type: boolean
                deprecated: false
                description: |
                  Indicates if the charge-item is to be charged only once or each time the `charge_on_event`
                  occurs. This parameter only applies to charge-items.
                example: null
              charge_on_option:
                type: string
                deprecated: false
                description: |
                  Indicates when the charge-item is to be charged. This parameter only applies to charge-items.

                  * on_event -
                    The item is charged at the occurrence of the event specified as `charge_on_event`
                    .
                  * immediately - The item is charged immediately on being added to the subscription.
                enum:
                - immediately
                - on_event
                example: null
              proration_type:
                type: string
                deprecated: false
                enum:
                - full_term
                - partial_term
                - none
                example: null
              usage_accumulation_reset_frequency:
                type: string
                deprecated: false
                enum:
                - never
                - subscription_billing_frequency
                example: null
              description:
                type: string
                deprecated: false
                description: |
                  **Limited availability**

                  Subscription-level item descriptions are available only on sites where this feature is enabled. Please reach out to the 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.

                  The description stored for this item on this quoted subscription. It is used on the customer-facing invoice instead of the description configured for the item price, and is returned as `entity_description` on the invoice [line item](/docs/api/invoices/invoice-object#invoice_line_items).

                  This attribute is returned only when a description has been stored for the item. When it is absent, the description configured for the item price applies. Whether a description is shown on the invoice at all continues to be controlled by the item price's [show_description_in_invoices](/docs/api/item_prices#show_description_in_invoices) setting.
                maxLength: 500
                example: null
            required:
            - item_price_id
            - item_type
            example: null
          example: null
        item_tiers:
          type: array
          deprecated: false
          description: |
            List of item tier.
          items:
            type: object
            deprecated: false
            properties:
              item_price_id:
                type: string
                deprecated: false
                description: |
                  The id of the item price to which this tier belongs.
                maxLength: 100
                example: null
              starting_unit:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The lowest value in the quantity tier.
                minimum: 1
                example: null
              ending_unit:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The highest value in the quantity tier.
                example: null
              price:
                type: integer
                format: int64
                default: 0
                deprecated: false
                description: |
                  The per-unit price for the tier when the `pricing_model`
                  is `tiered`
                  or `volume`.
                  The total cost for the item price when the `pricing_model`
                  is `stairstep`.
                  The value is in the minor unit of the currency.
                minimum: 0
                example: null
              starting_unit_in_decimal:
                type: string
                deprecated: false
                description: |
                  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 `ending_unit_in_decimal`
                  of the next lower tier. Returned only when the pricing_model is `tiered`
                  , `volume`
                  or `stairstep`
                  and [multi-decimal pricing](/docs/api/getting-started)
                  is enabled.
                maxLength: 33
                example: null
              ending_unit_in_decimal:
                type: string
                deprecated: false
                description: |
                  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 `starting_unit_in_decimal`
                  of the next higher tier. Returned only when the pricing_model is `tiered`
                  , `volume`
                  or `stairstep`
                  and [multi-decimal pricing](/docs/api/getting-started)
                  is enabled.
                maxLength: 33
                example: null
              price_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the per-unit price for the tier when the `pricing_model`
                  is `tiered`
                  or `volume`.
                  When the `pricing_model`
                  is `stairstep`
                  , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/getting-started)
                  is enabled.
                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
              index:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The index number of the subscription to which the item price is added. Provide a unique number between `0`
                  and `4`
                  (inclusive) for each subscription that is to be created.
                minimum: 0
                example: null
            required:
            - index
            - item_price_id
            - price
            - starting_unit
            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: |
                Action to be taken when the contract term completes.

                * renew -
                  * Contract term completes and a new contract term is started for the number of billing cycles specified in [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).
                  * The `action_at_term_end` for the new contract term is set to `renew`.
                * renew_once -
                  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 [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).

                  * The `action_at_term_end` for the new contract term is set to `cancel`.
                * cancel - Contract term completes and subscription is canceled.
                * evergreen - Contract term completes and the subscription renews.
              enum:
              - renew
              - evergreen
              - cancel
              - renew_once
              example: null
            total_contract_value:
              type: integer
              format: int64
              default: 0
              deprecated: false
              description: |
                The sum of the [totals](/docs/api/invoices/invoice-object#total)
                of all the invoices raised as part of the contract term. For `active`
                contract terms, this is a predicted value. The value depends on the [type of currency](/docs/api/quoted_subscriptions).
                If the subscription was [imported](/docs/api/quoted_subscriptions)
                with the contract term, then this value includes the value passed for `total_amount_raised`
                .
              minimum: 0
              example: null
            cancellation_cutoff_period:
              type: integer
              format: int32
              deprecated: false
              description: |
                The number of days before [`contract_end`](/docs/api/contract_terms/contract_term-object#contract_end)
                , 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.
              example: null
          required:
          - action_at_term_end
          - billing_cycle
          - contract_end
          - contract_start
          - total_contract_value
          example: null
      required:
      - id
      example: null
    Ramp:
      type: object
      description: "A `ramp` resource, or subscription ramp, represents a planned\
        \ change to a [`subscription`](/docs/api/subscriptions) that occurs at a future\
        \ date. Use this resource to define and schedule subscription modifications,\
        \ such as updating pricing, altering quantity, or transitioning to a different\
        \ plan, without immediately applying them.  \n**Note**\n\n* **Upcoming ramps\
        \ limit** : A subscription can have a maximum of 12 upcoming ramps at any\
        \ given time, excluding deleted ramps. Upcoming ramps are ramps with `status`\
        \ as [`scheduled`](/docs/api/ramps/ramp-object#status).\n* **Total ramps limit**:\
        \ A subscription can have a maximum of 100 ramps at any given time, excluding\
        \ deleted ramps.  \n\n#### Auto-draft conditions\n\nWhen you create or update\
        \ a ramp, Chargebee automatically moves any existing ramps scheduled after\
        \ that ramp to `draft` status if either of the following conditions is met:\n\
        \n* The new or updated ramp changes the subscription [term end date](subscriptions#subscription_current_term_end).\n\
        * The new or updated ramp changes the subscription billing frequency. That\
        \ is, either of the following [attributes](subscriptions#subscription_items)\
        \ is changed:\n  * `subscription_items[i].billing_period`\n  * `subscription_items[i].billing_period_unit`\n\
        \  * where `i` is the index where `subscription_items[i].item_type` is `plan`.\n\
        * The new or updated ramp introduces an [addon](item_prices#item_price_item_type)\
        \ that is not [applicable](attached_items) to the plan in one or more of the\
        \ subsequent ramps.\n"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            A unique and immutable identifier for the ramp.
          maxLength: 50
          example: null
        description:
          type: string
          deprecated: false
          description: |
            A brief summary of the pricing changes applied with this ramp.
          maxLength: 250
          example: null
        subscription_id:
          type: string
          deprecated: false
          description: |
            The ID of the subscription for which this ramp was created.
          maxLength: 50
          example: null
        effective_from:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Specifies the time when the changes to the subscription will be applied by executing the ramp.
          example: null
        status:
          type: string
          deprecated: false
          description: "The execution status of the ramp\n\n* succeeded - The ramp\
            \ completed successfully.\n* scheduled -\n  The ramp has been created\
            \ and scheduled for execution.  \n  **Note**\n  Excluding deleted ramps,\
            \ a subscription can have a maximum of 12 ramps in the `scheduled` `status`.\n\
            * draft -\n  The ramp is moved to `draft`\n  status when the associated\
            \ subscription is updated. The reason for the draft status can be explained\
            \ in the [status_transition_reason](/docs/api/ramps/ramp-object#status_transition_reason)\
            \  \n  **Note**\n  Ramps in draft state will not be executed.\n* failed\
            \ - The ramp did not complete because of an error.\n"
          enum:
          - scheduled
          - succeeded
          - failed
          - draft
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this resource was created.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            Version number of this resource. The `resource_version`
            is updated with a new timestamp in milliseconds for every change made to the resource.
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this resource was last updated.
          example: null
        items_to_remove:
          type: array
          deprecated: false
          description: |
            List of [item prices](/docs/api/item_prices)
            removed from the subscription through this ramp.
          items:
            type: string
            deprecated: false
            maxLength: 100
            example: null
          example: null
        coupons_to_remove:
          type: array
          deprecated: false
          description: |
            List of [coupons](/docs/api/coupons)
            removed from the subscription through this ramp.
          items:
            type: string
            deprecated: false
            maxLength: 100
            example: null
          example: null
        discounts_to_remove:
          type: array
          deprecated: false
          description: |
            List of [discounts](/docs/api/discounts)
            removed from the subscription through this ramp.
          items:
            type: string
            deprecated: false
            maxLength: 100
            example: null
          example: null
        deleted:
          type: boolean
          deprecated: false
          description: |
            Indicates if the ramp is marked as deleted. To retrieve deleted ramps, use the [List subscription ramps](/docs/api/ramps/list-ramps)
            endpoint with [include_deleted](/docs/api/ramps/list-ramps)
            set to `true`
            .
          example: null
        items_to_add:
          type: array
          deprecated: false
          description: |
            Details about the [item prices](/docs/api/item_prices)
            added to the subscription through this ramp.
          items:
            type: object
            deprecated: false
            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: |
                  The type of item. There must be one and only one item of type `plan`
                  in this list.

                  * charge - Charge
                  * plan - Plan
                  * addon - Addon
                enum:
                - plan
                - addon
                - charge
                example: null
              quantity:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The quantity of the item purchased
                minimum: 1
                example: null
              quantity_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 33
                example: null
              unit_price:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The price/per unit price of the item. When not provided, [the value set](/docs/api/item_prices/item-price-object)
                  for the item price is used. This is only applicable when the `pricing_model`
                  of the item price is `flat_fee`
                  or `per_unit`.
                  Also, it is only allowed when [price overriding](https://www.chargebee.com/docs/price-override.html)
                  is enabled for the site. The value depends on the [type of currency](/docs/api/currencies)
                  .
                minimum: 0
                example: null
              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/currencies)
                  is enabled.
                maxLength: 39
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The total amount for the item as determined from `unit_price`
                  , `free_quantity`
                  , `quantity`
                  and `item_tiers`
                  as applicable. The value depends on the [type of currency](/docs/api/currencies)
                  .
                minimum: 0
                example: null
              amount_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the total amount for the item, in major units of the currency. Always returned when [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 39
                example: null
              free_quantity:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The quantity of the item price that is available for free. Only the quantity more than this will be charged for the subscription. This is the same as [item_price.free_quantity](/docs/api/item_prices/item_price-object#free_quantity)
                  .
                minimum: 0
                example: null
              free_quantity_in_decimal:
                type: string
                deprecated: false
                description: |
                  The `free_quantity_in_decimal`
                  as set for the item price. Returned for quantity-based item prices when [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 33
                example: null
              billing_cycles:
                type: integer
                format: int32
                deprecated: false
                description: |
                  For the plan-item price:
                  the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then [the value set](/docs/api/item_prices/item-price-object)
                  for the plan-item price is used.

                  For addon-item prices:
                  If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)
                  are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then [the value set under attached addons](/docs/api/attached_items/attached-item-object)
                  is used. Further, if that value is not provided, then [the value set for the addon-item price](/docs/api/item_prices/item-price-object)
                  is used.
                minimum: 0
                example: null
              service_period_days:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The service period of the item in days from the day of charge.
                maximum: 730
                minimum: 1
                example: null
              metered_quantity:
                type: string
                deprecated: false
                description: |
                  This field represents the number of quantities recorded against this subscription item in the current term
                maxLength: 100
                example: null
              charge_once:
                type: boolean
                deprecated: false
                description: |
                  Indicates if the charge-item is to be charged only once or each time the `charge_on_event`
                  occurs. This parameter only applies to charge-items.
                example: null
              charge_on_option:
                type: string
                deprecated: false
                description: |
                  Indicates when the charge-item is to be charged. This parameter only applies to charge-items.

                  * immediately - The item is charged immediately on being added to the subscription.
                  * on_event -
                    The item is charged at the occurrence of the event specified as `charge_on_event`
                    .
                enum:
                - immediately
                - on_event
                example: null
              charge_on_event:
                type: string
                deprecated: false
                description: |
                  When `charge_on_option`
                  option is set to `on_event`
                  , this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.

                  * plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                  * contract_termination -
                    when a contract term is [terminated](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option)
                    .
                  * subscription_trial_start - the time when the trial period of the subscription begins.
                  * subscription_activation -
                    the moment a subscription enters an `active`
                    or `non-renewing`
                    state. Also includes reactivations of canceled subscriptions.
                enum:
                - subscription_trial_start
                - plan_activation
                - subscription_activation
                - contract_termination
                example: null
            required:
            - item_price_id
            - item_type
            example: null
          example: null
        items_to_update:
          type: array
          deprecated: false
          description: |
            Details about the [item prices](/docs/api/item_prices)
            updated in the subscription through this ramp.
          items:
            type: object
            deprecated: false
            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: |
                  The type of item. There must be one and only one item of type `plan`
                  in this list.

                  * charge - Charge
                  * plan - Plan
                  * addon - Addon
                enum:
                - plan
                - addon
                - charge
                example: null
              quantity:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The quantity of the item purchased
                minimum: 1
                example: null
              quantity_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)
                  is enabled.
                maxLength: 33
                example: null
              unit_price:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The price/per unit price of the item. When not provided, [the value set](/docs/api/item_prices/item-price-object)
                  for the item price is used. This is only applicable when the `pricing_model`
                  of the item price is `flat_fee`
                  or `per_unit`.
                  Also, it is only allowed when [price overriding](https://www.chargebee.com/docs/price-override.html)
                  is enabled for the site. The value depends on the [type of currency](/docs/api/currencies)
                  .
                minimum: 0
                example: null
              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/getting-started)
                  is enabled.
                maxLength: 39
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The total amount for the item as determined from `unit_price`
                  , `free_quantity`
                  , `quantity`
                  and `item_tiers`
                  as applicable. The value depends on the [type of currency](/docs/api/currencies)
                  .
                minimum: 0
                example: null
              amount_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the total amount for the item, in major units of the currency. Always returned when [multi-decimal pricing](/docs/api/getting-started)
                  is enabled.
                maxLength: 39
                example: null
              free_quantity:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The quantity of the item price that is available for free. Only the quantity more than this will be charged for the subscription. This is the same as [item_price.free_quantity](/docs/api/item_prices/item_price-object#free_quantity)
                  ..
                minimum: 0
                example: null
              free_quantity_in_decimal:
                type: string
                deprecated: false
                description: |
                  The `free_quantity_in_decimal`
                  as set for the item price. Returned for quantity-based item prices when [multi-decimal pricing](/docs/api/getting-started)
                  is enabled.
                maxLength: 33
                example: null
              billing_cycles:
                type: integer
                format: int32
                deprecated: false
                description: |
                  For the plan-item price:
                  the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then [the value set](/docs/api/item_prices/item-price-object)
                  for the plan-item price is used.

                  For addon-item prices:
                  If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)
                  are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then [the value set under attached addons](/docs/api/attached_items/attached-item-object)
                  is used. Further, if that value is not provided, then [the value set for the addon-item price](/docs/api/item_prices/item-price-object)
                  is used.
                minimum: 0
                example: null
              service_period_days:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The service period of the item in days from the day of charge.
                maximum: 730
                minimum: 1
                example: null
              metered_quantity:
                type: string
                deprecated: false
                description: |
                  This field represents the number of quantities recorded against this subscription item in the current term
                maxLength: 100
                example: null
              charge_once:
                type: boolean
                deprecated: false
                description: |
                  Indicates if the charge-item is to be charged only once or each time the `charge_on_event`
                  occurs. This parameter only applies to charge-items.
                example: null
              charge_on_option:
                type: string
                deprecated: false
                description: |
                  Indicates when the charge-item is to be charged. This parameter only applies to charge-items.

                  * on_event -
                    The item is charged at the occurrence of the event specified as `charge_on_event`
                    .
                  * immediately - The item is charged immediately on being added to the subscription.
                enum:
                - immediately
                - on_event
                example: null
              charge_on_event:
                type: string
                deprecated: false
                description: |
                  When `charge_on_option`
                  option is set to `on_event`
                  , this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.

                  * contract_termination -
                    when a contract term is [terminated](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option)
                    .
                  * subscription_activation -
                    the moment a subscription enters an `active`
                    or `non-renewing`
                    state. Also includes reactivations of canceled subscriptions.
                  * subscription_trial_start - the time when the trial period of the subscription begins.
                  * plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                enum:
                - subscription_trial_start
                - plan_activation
                - subscription_activation
                - contract_termination
                example: null
            required:
            - item_price_id
            - item_type
            example: null
          example: null
        coupons_to_add:
          type: array
          deprecated: false
          description: |
            Details about the [coupons](/docs/api/coupons)
            added to the subscription through this ramp.
          items:
            type: object
            deprecated: false
            properties:
              coupon_id:
                type: string
                deprecated: false
                description: |
                  Unique ID of the coupon to be added.
                maxLength: 100
                example: null
              apply_till:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  The date till when the coupon can be applied. Applicable for `limited_period`
                  [coupons](/docs/api/coupons)
                  only.
                example: null
            required:
            - coupon_id
            example: null
          example: null
        discounts_to_add:
          type: array
          deprecated: false
          description: |
            Details about the [discounts](/docs/api/discounts)
            added to the subscription through this ramp.
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  An immutable unique id for the discount. It is always auto-generated.
                maxLength: 50
                example: null
              invoice_name:
                type: string
                deprecated: false
                description: |
                  The name of the discount as it should appear on customer-facing pages and documents such as [invoices](/docs/api/invoices)
                  and [hosted pages](/docs/api/hosted_pages).
                  This is auto-generated based on the `type`
                  , `amount`
                  , and `currency_code`
                  of the discount. For example, it can be `10% off`
                  or `10$ off`
                  .
                maxLength: 100
                example: null
              type:
                type: string
                default: percentage
                deprecated: false
                description: "The type of discount.\nPossible value are:\n\n* fixed_amount\
                  \ - The specified amount will be given as discount.\n* offer_quantity\
                  \ -\n  A specified number of units of the item price are offered\
                  \ for free. The number of free units is specified in `discounts_to_add.quantity`.\
                  \  \n  **Constraints**\n\n  * `discounts_to_add.apply_on` must be\
                  \ `specific_item_price`.\n  * `discounts_to_add.item_price_id` must\
                  \ belong to an item price with [`pricing_model`](/docs/api/item_prices#pricing_model)\
                  \ `per_unit`.\n* percentage - The specified percentage will be given\
                  \ as discount.\n"
                enum:
                - fixed_amount
                - percentage
                - offer_quantity
                example: null
              percentage:
                type: number
                format: double
                deprecated: false
                description: |
                  The percentage of the original amount that should be deducted from it. Only applicable when `discount.type`
                  is percentage.
                maximum: 100
                minimum: 0.01
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The value of the discount. [The format of this value](/docs/api/currencies)
                  depends on the kind of currency.
                minimum: 0
                example: null
              quantity:
                type: integer
                format: int32
                deprecated: false
                description: "Specifies the number of free units provided for the\
                  \ item, without affecting the total quantity sold.  \n**Constraints**\n\
                  \n* `discounts_to_add.type` must be `offer_quantity`.\n* `discounts_to_add.apply_on`\
                  \ must be `specific_item_price`.\n* `discounts_to_add.item_price_id`\
                  \ must belong to an item price with [`pricing_model`](/docs/api/item_prices#pricing_model)\
                  \ `per_unit`.\n"
                minimum: 1
                example: null
              duration_type:
                type: string
                default: forever
                deprecated: false
                description: |
                  Specifies the time duration for which this discount is attached to the subscription.

                  * forever -
                    The discount is attached to the subscription and applied on the invoices till it is [explicitly removed](/docs/api/subscriptions/update-subscription-for-items#discounts_operation_type)
                    .
                  * 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 `period`
                    and `period_unit`
                    .
                  * one_time -
                    The discount stays attached to the subscription till it is applied on an invoice **once**.
                    It is removed after that from the subscription.
                enum:
                - one_time
                - forever
                - limited_period
                example: null
              period:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The duration of time for which the discount is attached to the subscription, in `period_units`.
                  Applicable only when `duration_type`
                  is `limited_period`.
                minimum: 1
                example: null
              period_unit:
                type: string
                deprecated: false
                description: |
                  The unit of time for `period`.
                  Applicable only when `duration_type`
                  is `limited_period`.

                  * week - A period of 7 days.
                  * year - A period of 1 calendar year.
                  * day - A period of 24 hours.
                  * month - A period of 1 calendar month.
                enum:
                - day
                - week
                - month
                - year
                example: null
              included_in_mrr:
                type: boolean
                deprecated: false
                description: |
                  The discount is included in MRR calculations for your site. This attribute is only applicable when `duration_type`
                  is `one_time`
                  and when the [feature is enabled](https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation)
                  in Chargebee. Also, If the [site-level setting](https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation)
                  is to exclude one-time discounts from MRR calculations, this value is always returned `false`.
                example: null
              apply_on:
                type: string
                deprecated: false
                description: |
                  The amount on the invoice to which the discount is applied.

                  * invoice_amount -
                    The discount is applied to the invoice `sub_total`
                    .
                  * specific_item_price -
                    The discount is applied to the `invoice.line_item.amount`
                    that corresponds to the item price specified by `item_price_id`
                    .
                enum:
                - invoice_amount
                - specific_item_price
                example: null
              item_price_id:
                type: string
                deprecated: false
                description: |
                  The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                  in the subscription to which the discount is to be applied. Relevant only when `apply_on`
                  = `specific_item_price`.
                maxLength: 100
                example: null
              created_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Timestamp indicating when this discount is created.
                example: null
            required:
            - apply_on
            - created_at
            - duration_type
            - id
            - included_in_mrr
            - type
            example: null
          example: null
        item_tiers:
          type: array
          deprecated: false
          description: |
            **Note**
            Allowed only when both of these conditions are met:

            * [Price overriding](https://www.chargebee.com/docs/2.0/price-override.html) is enabled for the site.
            * `pricing_model` of the item price is either `tiered`, `volume`, or `stairstep`.

            Overrides the [item_tiers](/docs/api/subscriptions/subscription-object#item_tiers) for specific `item_prices` of the subscription.
          items:
            type: object
            deprecated: false
            properties:
              item_price_id:
                type: string
                deprecated: false
                description: |
                  The id of the item price to which this tier belongs.
                maxLength: 100
                example: null
              starting_unit:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The lowest value in the quantity tier.
                minimum: 1
                example: null
              ending_unit:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The highest value in the quantity tier.
                example: null
              price:
                type: integer
                format: int64
                default: 0
                deprecated: false
                description: |
                  The per-unit price for the tier when the `pricing_model`
                  is `tiered`
                  or `volume`.
                  The total cost for the item price when the `pricing_model`
                  is `stairstep`.
                  The value is in the minor unit of the currency.
                minimum: 0
                example: null
              starting_unit_in_decimal:
                type: string
                deprecated: false
                description: |
                  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 `ending_unit_in_decimal`
                  of the next lower tier. Returned only when the pricing_model is `tiered`
                  , `volume`
                  or `stairstep`
                  and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 33
                example: null
              ending_unit_in_decimal:
                type: string
                deprecated: false
                description: |
                  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 `starting_unit_in_decimal`
                  of the next higher tier. Returned only when the pricing_model is `tiered`
                  , `volume`
                  or `stairstep`
                  and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 33
                example: null
              price_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the per-unit price for the tier when the `pricing_model`
                  is `tiered`
                  or `volume`.
                  When the `pricing_model`
                  is `stairstep`
                  , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 39
                example: null
              pricing_type:
                type: string
                deprecated: false
                description: |
                  Pricing type for the tier.

                  * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                  * flat_fee -
                    Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                    pricing model, `pricing_type`
                    will be set to `flat_fee`
                    by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                  * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                enum:
                - per_unit
                - flat_fee
                - package
                example: null
              package_size:
                type: integer
                format: int32
                deprecated: false
                description: |
                  Package size for the tier when pricing type is `package`.
                  Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                minimum: 1
                example: null
              index:
                type: integer
                format: int32
                deprecated: false
                description: |
                  Not used.
                minimum: 0
                example: null
            required:
            - index
            - item_price_id
            - price
            - starting_unit
            example: null
          example: null
        contract_term:
          type: object
          deprecated: false
          description: |
            An object that specifies the contract term details.
          properties:
            cancellation_cutoff_period:
              type: integer
              format: int32
              deprecated: false
              description: |
                The number of days before [contract_end](/docs/api/contract_terms/contract_term-object#contract_end)
                , 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.
              example: null
            renewal_billing_cycles:
              type: integer
              format: int32
              deprecated: false
              description: |
                Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as [billing_cycles](/docs/api/contract_terms/contract_term-object#billing_cycle)
                or a custom value depending on the [site configuration](https://www.chargebee.com/docs/billing/2.0/subscriptions/contract-terms#configuring-contract-terms)
                .
              example: null
            action_at_term_end:
              type: string
              default: renew
              deprecated: false
              description: |
                Action to be taken when the contract term completes.

                * evergreen - Contract term completes and the subscription renews.
                * renew -
                  * Contract term completes and a new contract term is started for the number of billing cycles specified in `renewal_billing_cycles`.
                  * The `action_at_term_end` for the new contract term is set to `renew`.
                * renew_once -
                  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 `renewal_billing_cycles`.
                  * The `action_at_term_end` for the new contract term is set to `cancel`.
                * cancel - Contract term completes and subscription is canceled.
              enum:
              - renew
              - evergreen
              - cancel
              - renew_once
              example: null
          required:
          - action_at_term_end
          example: null
        billing_configuration:
          type: object
          deprecated: false
          properties:
            po_number:
              type: string
              deprecated: false
              maxLength: 100
              example: null
          example: null
        status_transition_reason:
          type: object
          deprecated: false
          description: |
            Detailed reason for the status transition of a ramp to [draft](/docs/api/ramps/ramp-object#status)
            and [failed](/docs/api/ramps/ramp-object#status)
            status.
          properties:
            code:
              type: string
              deprecated: false
              description: |
                Unique code of the `status_transition_reason`
                .
              maxLength: 100
              example: null
            message:
              type: string
              deprecated: false
              description: |
                A message to explain the `status_transition_reason`
                .
              maxLength: 250
              example: null
          example: null
        entitlement_overrides_to_add:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              entity_id:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              entity_type:
                type: string
                deprecated: false
                enum:
                - plan_price
                - addon_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
            required:
            - entity_id
            - entity_type
            - feature_id
            - is_enabled
            example: null
          example: null
        entitlement_overrides_to_update:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              entity_id:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              entity_type:
                type: string
                deprecated: false
                enum:
                - plan_price
                - addon_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
            required:
            - entity_id
            - entity_type
            - feature_id
            - is_enabled
            example: null
          example: null
        entitlement_overrides_to_remove:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              entity_id:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              entity_type:
                type: string
                deprecated: false
                enum:
                - plan_price
                - addon_price
                - charge
                example: null
              feature_id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
            required:
            - entity_id
            - entity_type
            - feature_id
            example: null
          example: null
      required:
      - created_at
      - deleted
      - effective_from
      - id
      - status
      - subscription_id
      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
    RecordPurchaseFailedEvent:
      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:
            recorded_purchase:
              $ref: "#/components/schemas/RecordedPurchase"
            customer:
              $ref: "#/components/schemas/Customer"
          required:
          - customer
          - recorded_purchase
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    RecordedPurchase:
      type: object
      description: |
        **Important**

        * Handle the **synchronous** API response first. Record a Purchase can fail immediately (for example, an incorrect `app_id`, a malformed URL or request, or recording a purchase that already belongs to a different customer) before a job is created---treat these as standard API errors (`4xx`). To reassign an existing omnichannel subscription to another customer, use [Move an omnichannel subscription](/docs/api/omnichannel_subscriptions/move-an-omnichannel-subscription) instead of re-recording the purchase.
        * After the call is accepted, purchase validation with Apple or Google is **asynchronous** . Track the job with `status` (`in_process` → `completed`, `failed`, or `ignored`). Omnichannel subscription or one-time order creation happens only after successful async completion.
        * This resource is applicable for Apple App Store and Google Play Store.

        The recorded purchase resource represents a background job that syncs in-app purchases made through Apple App Store and Google Play Store with Chargebee. The [status](/docs/api/recorded_purchases/recorded_purchase-object#status) (`in_process`, `completed`, `failed`, and `ignored`) attribute represents the current status of the background job.

        ### Record Apple and Google in-app purchases and retrieve linked omnichannel resources

        You can record subscription and one-time-order purchases made on Apple App Store or Google Play Store, then retrieve the resulting omnichannel resources.

        To record a purchase and retrieve details, follow these steps:

        1. Use the [Record a Purchase API](/docs/api/recorded_purchases/record-a-purchase) with `app_id`, `customer[id]`, and exactly one store payload:

           * **Apple App Store (preferred)** : `apple_app_store[transaction_id]` for a new subscription, expired re-purchase, or one-time product.

           * **Apple App Store (receipt path)** : `apple_app_store[receipt]` and `apple_app_store[product_id]`.

           * **Google Play Store (preferred)** : `google_play_store[order_id]` for a subscription or one-time order.

           * **Google Play Store (subscription token path)** : `google_play_store[purchase_token]`.

           * **Google Play Store (one-time order token path)** : `google_play_store[purchase_token]` and `google_play_store[product_id]`.

        2. The API response includes a `recorded_purchase` object with the [status](/docs/api/recorded_purchases/recorded_purchase-object#status) of the job.

        3. When recording completes successfully, `status` updates from `in_process` to `completed` and Chargebee sets `omnichannel_transaction_id` plus either:

           * **Subscription** : `linked_omnichannel_subscriptions`, with webhook [`omnichannel_subscription_created`](/docs/api/events/webhook/omnichannel_subscription_created) (or [`omnichannel_subscription_imported`](/docs/api/events/webhook/omnichannel_subscription_imported)).
           * **One-time order** : `linked_omnichannel_one_time_orders`, with webhook [`omnichannel_one_time_order_created`](/docs/api/events/webhook/omnichannel_one_time_order_created).
        4. In addition to webhooks, retrieve the job by the `recorded_purchase` [id](/docs/api/recorded_purchases/recorded_purchase-object#id) returned when you record the purchase.

        If `status` is `failed`, review [error_detail](/docs/api/recorded_purchases/recorded_purchase-object#error_detail) and see [`record_purchase_failed`](/docs/api/events/webhook/record_purchase_failed).

        If `status` is `ignored`, the purchase was already recorded in Chargebee as an omnichannel subscription or one-time order. Chargebee does not create a new linked resource for this job---use the existing omnichannel subscription or one-time order. Linked IDs and `omnichannel_transaction_id` are populated when `status` is `completed`, not for `ignored`.

        See also [omnichannel events](/docs/api/omnichannel_events).
      properties:
        id:
          type: string
          deprecated: false
          description: |
            A unique ID generated by Chargebee for the recorded purchase job.
          maxLength: 40
          example: null
        customer_id:
          type: string
          deprecated: false
          description: |
            The `id`
            of the [customer](/docs/api/customers/customer-object#id)
            object associated with this purchase. If the `customer_id`
            is not present in Chargebee when the [record_a_purchase](/docs/api/recorded_purchases/record-a-purchase)
            API request is made, Chargebee automatically creates the customer using the details provided in the request.
          maxLength: 100
          example: null
        app_id:
          type: string
          deprecated: false
          description: |
            App Identifier in Chargebee. This is the handle created by Chargebee for your app. To get the `app_id`:

            * For **Apple** , follow [these steps](https://www.chargebee.com/docs/billing/2.0/mobile-subscriptions/omnichannel-app-store#create-an-omnichannel-subscription-for-in-app-purchases).
            * For **Google** , follow [these steps](https://www.chargebee.com/docs/billing/2.0/mobile-subscriptions/omnichannel-play-store#connect-google-app-to-chargebee-to-generate-unique-app-id-and-notifications-url).
          maxLength: 100
          example: null
        source:
          type: string
          deprecated: false
          description: |
            The source where the purchase is originally made and managed.

            * google_play_store - The purchase originated from the Google Play Store.
            * apple_app_store - The purchase originated from the Apple App Store.
          enum:
          - apple_app_store
          - google_play_store
          example: null
        status:
          type: string
          deprecated: false
          description: |
            Current status of the recorded purchase operation.

            * completed - The purchase recording job completed successfully. You receive `omnichannel_transaction_id` and either `linked_omnichannel_subscriptions` (subscription purchase) or `linked_omnichannel_one_time_orders` (one-time order purchase).
            * ignored -
              Terminal status when the purchase was already recorded in Chargebee as an omnichannel subscription or one-time order (same store purchase / customer association).
              Chargebee does **not** create a new linked resource for this job. Use the existing omnichannel subscription or one-time order in Chargebee rather than treating this job as a new successful recording.
              `linked_omnichannel_subscriptions` / `linked_omnichannel_one_time_orders` and `omnichannel_transaction_id` are returned when `status` is `completed`, not for `ignored`.
            * failed -
              The purchase recording job failed. You do **not** receive `omnichannel_transaction_id` or linked subscription / one-time-order objects. Check the [error_detail](/docs/api/recorded_purchases/recorded_purchase-object#error_detail)
              attribute for the failure reason. Chargebee may also emit [`record_purchase_failed`](/docs/api/events/webhook/record_purchase_failed).
            * in_process - The purchase recording job is in progress. You do **not** yet receive `omnichannel_transaction_id` or linked subscription / one-time-order objects.
          enum:
          - in_process
          - completed
          - failed
          - ignored
          example: null
        omnichannel_transaction_id:
          type: string
          deprecated: false
          description: |
            The `id`
            of the [omnichannel transaction](/docs/api/omnichannel_transactions/omnichannel_transaction-object#id)
            object associated with the purchase. Present when `status` is `completed`.
          maxLength: 100
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp when the `recorded_purchase` resource was created in Chargebee.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            Version number of this resource. The `resource_version`
            is updated with a new timestamp in milliseconds for every change made to the resource.
          example: null
        linked_omnichannel_subscriptions:
          type: array
          deprecated: false
          description: |
            The list of omnichannel subscriptions created for this purchase. Applicable when the recorded purchase is a subscription. Present when `status` is `completed`.
          items:
            type: object
            deprecated: false
            properties:
              omnichannel_subscription_id:
                type: string
                deprecated: false
                description: |
                  The `id`
                  of the [omnichannel subscription](/docs/api/omnichannel_subscriptions/omnichannel_subscription-object#id)
                  object associated with this purchase.
                maxLength: 100
                example: null
            example: null
          example: null
        linked_omnichannel_one_time_orders:
          type: array
          deprecated: false
          description: |
            The list of omnichannel one-time orders created for this purchase. Applicable when the recorded purchase is a one-time order. Present when `status` is `completed`.
          items:
            type: object
            deprecated: false
            properties:
              omnichannel_one_time_order_id:
                type: string
                deprecated: false
                description: |
                  The `id`
                  of the [omnichannel one-time order](/docs/api/omnichannel_one_time_orders/omnichannel_one_time_order-object#id)
                  object associated with this purchase.
                maxLength: 100
                example: null
            example: null
          example: null
        error_detail:
          type: object
          deprecated: false
          description: |
            Applicable only for recorded purchases where the job status is `failed`.
            It provides more details about the failure.
          properties:
            error_message:
              type: string
              deprecated: false
              description: |
                A descriptive message about the `error_detail`.
              maxLength: 500
              example: null
          example: null
      required:
      - app_id
      - created_at
      - customer_id
      - id
      - source
      - status
      example: null
    ReferenceCount:
      type: object
      description: |
        This resource returns the number of items.
      properties:
        type:
          type: string
          deprecated: false
          description: |
            The `type`
            of the `item`

            * charge - Charge
            * plan - Plan
            * addon - Addon
          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
    SalesOrder:
      type: object
      description: |
        Sales orders represent the contractual agreement and commitment for services between a seller and a buyer. They act as a seamless interface connecting any sales system (such as CPQ, CRM, or Customer Portal) with Chargebee Billing. The sales order captures the following essential components

        * Order Line Items including discounts and ramps
        * Billing and payment configuration
        * Contract terms and conditions
        * Customer information including billing and shipping contacts
        * Meta data
      properties:
        id:
          type: string
          deprecated: false
          description: |
            External identifier of the sales order.
          maxLength: 50
          example: null
        version:
          type: integer
          format: int32
          default: 1
          deprecated: false
          description: |
            Version of the sales order.
          example: null
        renewed_from_order_id:
          type: string
          deprecated: false
          description: |
            The unique identifier of the original sales order from which this order was renewed. This field is used to track renewal orders and link them to their previous sales transactions.
          maxLength: 50
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Indicates the timestamp at which this sales order was last updated.
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating sales order created.
          example: null
        po_number:
          type: string
          deprecated: false
          description: |
            Buyer's purchase order reference number.
          maxLength: 100
          example: null
        meta_data:
          type: string
          deprecated: false
          description: |
            A set of key-value pairs stored as additional information for the subscription. [Learn more](/docs/api/sales_orders)
            .
          maxLength: 65000
          example: null
        quote_id:
          type: string
          deprecated: false
          description: |
            Primary quote id for which the order was placed.
          maxLength: 100
          example: null
        effective_date:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Effective start date of the order signifies when the contract is signed and becomes legally binding.
          example: null
        end_date:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The date when the order is considered completed, cancelled, or no longer valid.
          example: null
        business_entity_id:
          type: string
          deprecated: false
          description: |
            The unique ID of the
            [business entity](/docs/api/getting-started)
            of this sales order.
          maxLength: 50
          example: null
        customer_id:
          type: string
          deprecated: false
          description: |
            The unique ID of the customer to which this sales order belongs.
          maxLength: 50
          example: null
        subscription_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        currency_code:
          type: string
          deprecated: false
          description: |
            The currency code (ISO 4217 format) of the sales order.
          maxLength: 3
          example: null
        subscription_ids:
          type: array
          deprecated: false
          description: |
            The unique identifiers of the [subscriptions](/docs/api/subscriptions)
            that are bundled as part of this sales order.
          items:
            type: string
            deprecated: false
            maxLength: 50
            example: null
          example: null
        status:
          type: string
          default: active
          deprecated: false
          description: |
            Status of the sales order.

            * completed - completed
            * active - active
          enum:
          - active
          - completed
          example: null
        deleted:
          type: boolean
          deprecated: false
          example: null
        line_items:
          type: array
          deprecated: false
          description: |
            Line items of this sales order
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  External identifier of the sales order line item.
                maxLength: 50
                example: null
              association_id:
                type: string
                deprecated: false
                description: |
                  A reference of line item to associate with other entities like line item tiers.
                maxLength: 105
                example: null
              item_price_id:
                type: string
                deprecated: false
                description: |
                  ID of the item price.
                maxLength: 100
                example: null
              name:
                type: string
                deprecated: false
                description: |
                  Name of the item.
                maxLength: 100
                example: null
              quantity:
                type: string
                default: "1"
                deprecated: false
                description: |
                  Quantity of the item.
                maxLength: 39
                example: null
              unit_price:
                type: string
                deprecated: false
                description: |
                  Unit price of the item.
                maxLength: 39
                example: null
              billable_unit_price:
                type: string
                deprecated: false
                maxLength: 39
                example: null
              billable_quantity:
                type: string
                deprecated: false
                maxLength: 39
                example: null
              billable_amount:
                type: string
                deprecated: false
                maxLength: 39
                example: null
              billing_period:
                type: integer
                format: int32
                deprecated: false
                description: |
                  Defines billing period for the subscription item
                minimum: 1
                example: null
              billing_period_unit:
                type: string
                deprecated: false
                description: |
                  Defines billing period unit in association with the billing period.

                  * week - A period of 7 days.
                  * year - A period of 1 calendar year.
                  * day - A period of 24 hours.
                  * month - A period of 1 calendar month.
                enum:
                - day
                - week
                - month
                - year
                example: null
              service_period_days:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The service period of the item in days from the day of charge.
                maximum: 730
                minimum: 1
                example: null
              charge_on_event:
                type: string
                deprecated: false
                description: |
                  When `charge_on_option`
                  option is set to `on_event`
                  , this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.

                  * plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                  * subscription_trial_start - the time when the trial period of the subscription begins.
                  * contract_termination -
                    when a contract term is [terminated](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option)
                    .
                  * subscription_activation -
                    the moment a subscription enters an `active`
                    or `non-renewing`
                    state. Also includes reactivations of canceled subscriptions.
                  * subscription_creation - the time of creation of the subscription.
                enum:
                - subscription_creation
                - subscription_trial_start
                - plan_activation
                - subscription_activation
                - contract_termination
                example: null
              charge_once:
                type: boolean
                deprecated: false
                description: |
                  Indicates if the charge-item is to be charged only once or each time the `charge_on_event`
                  occurs. This parameter only applies to charge-items.
                example: null
              billing_cycles:
                type: integer
                format: int32
                deprecated: false
                description: |
                  Number of billing cycles for which this line item remains valid.
                minimum: 0
                example: null
              billing_type:
                type: string
                deprecated: false
                description: |
                  Billing type of the item.

                  * one_time - Item gets billed once
                  * event_based - Item gets billed on specific events
                  * recurring - Item gets billed at regular intervals
                enum:
                - recurring
                - one_time
                - event_based
                example: null
              start_date:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Start date of the line item.
                example: null
              end_date:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  End date of the line item.
                example: null
              trial_end:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  The date/time when the trial period of the item ends.
                example: null
              free_period:
                type: integer
                format: int32
                deprecated: false
                minimum: 1
                example: null
              free_period_unit:
                type: string
                deprecated: false
                enum:
                - day
                - week
                - month
                - year
                example: null
            required:
            - billing_type
            - id
            - item_price_id
            - quantity
            - start_date
            - unit_price
            example: null
          example: null
        billing_addresses:
          type: array
          deprecated: false
          description: |
            Billing address for a customer.
          items:
            type: object
            deprecated: false
            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: |
                  The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
                  without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`
                  as `AZ`
                  (not `US-AZ`
                  ). For Tamil Nadu (India), set as `TN`
                  (not `IN-TN`
                  ). For British Columbia (Canada), set as `BC`
                  (not `CA-BC`
                  ).
                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 country of the customer. Must be\
                  \ one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                  .\n\n**Note**:\nIf you enter an invalid country code, the system\
                  \ will return an error.  \n**Brexit**\n\nIf you have enabled [EU\
                  \ VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021 or later,\
                  \ or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                  \ the Brexit configuration, then `XI` (the code for **United Kingdom\
                  \ - Northern Ireland**) is available as an 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.
                  * invalid - Address is invalid.
                  * valid - Address was validated successfully.
                enum:
                - not_validated
                - valid
                - partially_valid
                - invalid
                example: null
            example: null
          example: null
        discounts:
          type: array
          deprecated: false
          description: |
            List of discounts for this subscription
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  An immutable code for the discount. It is always auto-generated.
                maxLength: 50
                example: null
              invoice_name:
                type: string
                deprecated: false
                description: |
                  The name of the discount as it should appear on customer-facing pages and documents such as [invoices](/docs/api/invoices)
                  and [hosted pages](/docs/api/hosted_pages).
                  This is auto-generated based on the `type`
                  , `amount`
                  , and `currency_code`
                  of the discount. For example, it can be `10% off`
                  or `10$ off`
                  .
                maxLength: 100
                example: null
              type:
                type: string
                default: percentage
                deprecated: false
                description: |
                  The type of discount.
                  Possible value are:

                  * fixed_amount - The specified amount will be given as discount.
                  * percentage - The specified percentage will be given as discount.
                enum:
                - fixed_amount
                - percentage
                - offer_quantity
                example: null
              apply_on:
                type: string
                deprecated: false
                description: |
                  The amount on the invoice to which the discount is applied.

                  * invoice_amount -
                    The discount is applied to the invoice `sub_total`
                    .
                  * specific_item_price -
                    The discount is applied to the `invoice.line_item.amount`
                    that corresponds to the item price specified by `item_price_id`
                    .
                enum:
                - invoice_amount
                - specific_item_price
                example: null
              duration_type:
                type: string
                default: forever
                deprecated: false
                description: |
                  Specifies the time duration for which this discount is attached to the subscription.

                  * forever -
                    The discount is attached to the subscription and applied on the invoices till it is [explicitly removed](/docs/api/subscriptions/update-subscription-for-items#discounts_operation_type)
                    .
                  * 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 `period`
                    and `period_unit`
                    .
                  * one_time -
                    The discount stays attached to the subscription till it is applied on an invoice **once**.
                    It is removed after that from the subscription.
                enum:
                - one_time
                - forever
                - limited_period
                example: null
              percentage:
                type: number
                format: double
                deprecated: false
                description: |
                  The percentage of the original amount that should be deducted from it. Only applicable when `discount.type`
                  is percentage.
                maximum: 100
                minimum: 0.01
                example: null
              amount:
                type: string
                deprecated: false
                description: |
                  The value of the discount. [The format of this value](/docs/api/currencies)
                  depends on the kind of currency. This is only applicable when `discount.type`
                  is `fixed_amount`.
                maxLength: 39
                example: null
              coupon_id:
                type: string
                deprecated: false
                description: |
                  ID/code of the coupon to be applied.
                maxLength: 50
                example: null
              period:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The duration of time for which the discount is attached to the subscription, in `period_units`.
                  Applicable only when `duration_type`
                  is `limited_period`.
                minimum: 1
                example: null
              period_unit:
                type: string
                deprecated: false
                description: |
                  The unit of time for `period`.
                  Applicable only when `duration_type`
                  is `limited_period`.

                  * day - A period of 24 hours.
                  * week - A period of 7 days.
                  * month - A period of 1 calendar month.
                  * year - A period of 1 calendar year.
                enum:
                - day
                - week
                - month
                - year
                example: null
              item_price_id:
                type: string
                deprecated: false
                description: |
                  The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                  in the subscription to which the discount is to be applied. Relevant only when `apply_on`
                  = `specific_item_price`.
                maxLength: 100
                example: null
              start_date:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Start date of the discount.
                example: null
              end_date:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  End date of the discount.
                example: null
              apply_till:
                type: integer
                format: unix-time
                deprecated: false
                example: null
            required:
            - apply_on
            - duration_type
            - id
            - start_date
            - type
            example: null
          example: null
        shipping_addresses:
          type: array
          deprecated: false
          description: |
            Shipping address for the subscription.
          items:
            type: object
            deprecated: false
            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: |
                  The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
                  without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`
                  as `AZ`
                  (not `US-AZ`
                  ). For Tamil Nadu (India), set as `TN`
                  (not `IN-TN`
                  ). For British Columbia (Canada), set as `BC`
                  (not `CA-BC`
                  ).
                maxLength: 50
                example: null
              state:
                type: string
                deprecated: false
                description: |
                  The state/province name.
                maxLength: 50
                example: null
              country:
                type: string
                deprecated: false
                description: "The billing address country of the customer. Must be\
                  \ one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                  .\n\n**Note**:\nIf you enter an invalid country code, the system\
                  \ will return an error.  \n**Brexit**\n\nIf you have enabled [EU\
                  \ VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021 or later,\
                  \ or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                  \ the Brexit configuration, then `XI` (the code for **United Kingdom\
                  \ - Northern Ireland**) is available as an 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
        line_item_tiers:
          type: array
          deprecated: false
          description: |
            The pricing details of `line_items`
            which have `pricing_model`
            as `tiered`
            , `volume`
            or `stairstep`.
            [Learn more](https://www.chargebee.com/docs/plans.html#pricing-models)
            about pricing models.
          items:
            type: object
            deprecated: false
            properties:
              starting_unit:
                type: string
                deprecated: false
                description: |
                  The lowest value in the quantity tier.
                maxLength: 39
                example: null
              ending_unit:
                type: string
                deprecated: false
                description: |
                  The highest value in the quantity tier.
                maxLength: 39
                example: null
              price:
                type: string
                deprecated: false
                description: |
                  The per-unit price for the tier when the `pricing_model`
                  is `tiered`
                  or `volume`.
                  The total cost for the item price when the `pricing_model`
                  is `stairstep`.
                  The value is in the minor unit of the currency.
                maxLength: 39
                example: null
              pricing_type:
                type: string
                deprecated: false
                description: |
                  Pricing type for the tier.

                  * flat_fee -
                    Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                    pricing model, `pricing_type`
                    will be set to `flat_fee`
                    by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                  * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                  * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                enum:
                - per_unit
                - flat_fee
                - package
                example: null
              package_size:
                type: integer
                format: int32
                deprecated: false
                description: |
                  Package size for the tier when pricing type is `package`.
                  Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                minimum: 1
                example: null
              line_item_association_id:
                type: string
                deprecated: false
                description: |
                  Association id of line item tho whom this line item tiers belongs.
                maxLength: 105
                example: null
            required:
            - price
            - starting_unit
            example: null
          example: null
        payment_configuration:
          type: object
          deprecated: false
          description: |
            Payment configuration of this sales order
          properties:
            auto_collection:
              type: string
              deprecated: false
              description: |
                Auto collection status.

                * off - off
                * on - on
              enum:
              - "on"
              - "off"
              example: null
            payment_source_id:
              type: string
              deprecated: false
              description: |
                Identifier of the payment source for which this transaction is made
              maxLength: 50
              example: null
            payment_intent_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
            offline_payment_method:
              type: string
              deprecated: false
              description: |
                The preferred offline payment method for the sales order.

                * cash - Cash
                * mx_automated_bank_transfer - MX Automated Bank Transfer
                * us_automated_bank_transfer - US Automated Bank Transfer
                * no_preference - No Preference
                * eu_automated_bank_transfer - EU Automated Bank Transfer
                * jp_automated_bank_transfer - JP Automated Bank Transfer
                * check - Check
                * custom - Custom
                * uk_automated_bank_transfer - UK Automated Bank Transfer
                * ach_credit - ACH Credit
                * sepa_credit - SEPA Credit
                * bank_transfer - Bank Transfer
                * boleto - Boleto
              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
          example: null
        billing_configuration:
          type: object
          deprecated: false
          description: |
            Configurations controlling billing behavior and invoice generation workflows.
          properties:
            create_pending_invoices:
              type: boolean
              deprecated: false
              description: |
                Indicates if pending invoices should be created.
              example: null
            invoice_immediately:
              type: boolean
              deprecated: false
              description: |
                Indicates whether the invoices for this order are generated with a pending status.This attribute is set to true automatically when the subscription has item prices that belong to metered items.
              example: null
            first_invoice_pending:
              type: boolean
              deprecated: false
              description: |
                Indicates if you want to bill the usages from the previous billing cycle. This creates a pending invoice immediately on subscription creation.
              example: null
            invoice_usages:
              type: boolean
              deprecated: false
              description: |
                Setting this attribute to `true` would invoice the overages for the metered item during subscription changes
              example: null
            net_term_days:
              type: integer
              format: int32
              deprecated: false
              description: |
                Net terms in days.
              example: null
            invoice_date:
              type: integer
              format: unix-time
              deprecated: false
              description: |
                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.
              example: null
            next_renewal_date:
              type: integer
              format: unix-time
              deprecated: false
              example: null
            billing_cycles_to_invoice:
              type: integer
              format: int32
              deprecated: false
              description: |
                The number of billing cycles to be invoiced in advance for this order. If not specified, the invoice will be generated for the first billing cycle by default.
              example: null
            billing_alignment_mode:
              type: string
              deprecated: false
              description: |
                Override the billing alignment mode 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
          example: null
        renewal_term:
          type: object
          deprecated: false
          description: |
            Renewal term for this sales order.
          properties:
            end_of_term_action:
              type: string
              deprecated: false
              description: |
                The action at end of contract term

                * cancel - Contract term completes and subscription is canceled.
                * renew -
                  * Contract term completes and a new contract term is started for the number of billing cycles specified in [`renewal_billing_cycles`](/docs/api/sales_orders/sales_order-object#renewal_term_renewal_billing_cycles).
                  * The `end_of_term_action` for the new contract term is set to `renew`.
                * evergreen - Contract term completes and the subscription renews.
              enum:
              - renew
              - cancel
              - evergreen
              example: null
            cancellation_cutoff_period:
              type: integer
              format: int32
              deprecated: false
              description: |
                The number of days before contract_end, 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.
              example: null
            renewal_billing_cycles:
              type: integer
              format: int32
              deprecated: false
              description: |
                Specifies the number of billing cycles for which the contract will be renewed.
              example: null
          required:
          - end_of_term_action
          example: null
        credit_lines:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              amount:
                type: string
                deprecated: false
                maxLength: 39
                example: null
              unit_price:
                type: string
                default: "0.00"
                deprecated: false
                maxLength: 39
                example: null
              quantity:
                type: string
                deprecated: false
                maxLength: 33
                example: null
              line_item_association_id:
                type: string
                deprecated: false
                maxLength: 105
                example: null
            required:
            - amount
            - unit_price
            example: null
          example: null
        entitlement_overrides:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              feature_id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              entity_id:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              entity_type:
                type: string
                deprecated: false
                enum:
                - item_price
                - subscription
                example: null
              value:
                type: string
                deprecated: false
                maxLength: 39
                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
            required:
            - entity_id
            - entity_type
            - feature_id
            - id
            - is_enabled
            - start_date
            example: null
          example: null
      required:
      - created_at
      - currency_code
      - customer_id
      - deleted
      - effective_date
      - id
      - status
      - subscription_id
      - version
      example: null
    SalesOrderCreatedEvent:
      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:
            sales_order:
              $ref: "#/components/schemas/SalesOrder"
          required:
          - sales_order
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SalesOrderUpdatedEvent:
      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:
            sales_order:
              $ref: "#/components/schemas/SalesOrder"
          required:
          - sales_order
          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
    SettingsPreference:
      type: object
      properties: {}
      example: null
    SettingsPreferenceDefinition:
      type: object
      properties: {}
      example: null
    Site:
      type: object
      description: |
        Represents a platform site in Chargebee.
        Each platform site includes a unique `id`, the associated `site_id`, and a `domain`, along with its `site_type` and `created_at` timestamp.
      properties:
        site_owner_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        id:
          type: string
          deprecated: false
          description: |
            Unique identifier of the platform site. Maximum length is 40 characters.
          maxLength: 60
          example: null
        currency_code:
          type: string
          deprecated: false
          maxLength: 3
          example: null
        status:
          type: string
          deprecated: false
          enum:
          - active
          - disabled
          - cancelled
          example: null
        type:
          type: string
          deprecated: false
          enum:
          - sandbox
          - live
          example: null
        domain:
          type: string
          deprecated: false
          description: |
            Domain name of the platform site. Maximum length is 50 characters.
          maxLength: 50
          minLength: 4
          example: null
        locale:
          type: string
          default: en
          deprecated: false
          enum:
          - en
          - fr
          - de
          - it
          - pt
          - es
          - da
          - tr
          - fi
          - sl
          - zh
          - sv
          - ja
          - ru
          - nl
          - lt
          - lv
          - et
          - pl
          - id
          - cs
          - sk
          - ko
          - "no"
          - ro
          - th
          - vi
          - bg
          - hu
          - uk
          - hr
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this platform site was created.
          example: null
        timezone:
          type: string
          default: UTC
          deprecated: false
          maxLength: 50
          example: null
        created_from_ip:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        linked_sites:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                maxLength: 60
                example: null
              domain:
                type: string
                deprecated: false
                maxLength: 50
                minLength: 4
                example: null
              type:
                type: string
                deprecated: false
                enum:
                - sandbox
                - live
                example: null
              status:
                type: string
                deprecated: false
                enum:
                - active
                - disabled
                - cancelled
                example: null
              created_at:
                type: integer
                format: unix-time
                deprecated: false
                example: null
            required:
            - created_at
            - domain
            example: null
          example: null
      required:
      - created_at
      - domain
      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: |
        Represents a site owner in Chargebee.
        Each site owner includes a unique `id` and required `email`, and can optionally include `name`, `customer_id`, and `updated_at`.
      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
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Unix timestamp when this site owner was last updated.
          example: null
      required:
      - created_at
      - 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
    Status:
      type: string
      deprecated: false
      enum:
      - scheduled
      - rescheduled
      - succeeded
      - failed
      - deferred
      - delivered
      - opened
      - bounced
      - dropped
      - active
      - archived
      - deleted
      - available
      - exhausted
      - in_grace_period
      example: null
    Subscription:
      type: object
      additionalProperties: true
      description: "A Chargebee subscription connects a customer record to products/services.\
        \ It describes what the customer has signed up for and how often they're charged\
        \ for it. The essential components of a subscription are:\n\n* A [plan-item\
        \ price](/docs/api/item_prices).\n* Any addon- and charge-item prices applied\
        \ to the subscription.\n* Any [coupons](/docs/api/coupons) applied.\n* Any\
        \ [discounts](/docs/api/discounts) applied.\n\nThe charges in a subscription\
        \ are billed via invoices.  \n**Note:**\nThe maximum number of subscriptions\
        \ for any given [customer](/docs/api/customers)\n([active](/docs/api/subscriptions/subscription-object#status)\n\
        or not) is 900.  \n\n#### Subscription billing frequencies\n\nChargebee offers\
        \ two billing frequency options for subscriptions:\n\n* **Plan-based billing**\
        \ (`default`): Subscriptions are billed based on the billing period defined\
        \ for the item price of the `item_type` `plan`. [Learn more](https://www.chargebee.com/docs/billing/2.0/subscriptions/subscriptions#plan-based-billing).\n\
        \n* **Multi-frequency billing** : Subscriptions are billed according to the\
        \ billing period of each recurring item price within the subscription. [Learn\
        \ more](https://www.chargebee.com/docs/billing/2.0/subscriptions/multi-frequency-billing).\n\
        \n  **Important**\n\n  [Limitations](https://www.chargebee.com/docs/billing/2.0/subscriptions/multi-frequency-billing#limitations)\
        \ of Multi-frequency billing.\n\nThe selection of the billing frequency preference\
        \ is configured at the site level.  \n\n#### Item price compatibility in a\
        \ subscription\n\nWhen creating or updating a subscription, one of the item\
        \ prices specified under subscription_items must be a plan-item price. The\
        \ remaining must be compatible addon- or charge-item prices. An item price\
        \ is compatible with a plan-item price if their currencies are the same. Additionally,\
        \ an addon-item price is compatible with a plan-item price only if their billing\
        \ frequencies meet the following conditions:  \n\n| `period_unit` for plan-item\
        \ price | Compatible `period_unit` for addon-item price |                \
        \                                                                        \
        \                                                                        \
        \                                Compatible period for addon-item price  \
        \                                                                        \
        \                                                                        \
        \                                              |\n|-----------------------------------|-----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n\
        | `day`                             | `day`                              \
        \           | The `period` of the plan-item price should be divisible by the\
        \ `period` of the addon-item price. **Example** If the `period` of the plan-item\
        \ price is `10`, then the period of the addon-item price can be `10`, `5`,\
        \ `2`, or `1`.                                                           \
        \                                                                        \
        \                                                               |\n| `week`\
        \                            | `week` or `day`                           \
        \    | The `period` (in days) of the plan-item price should be divisible by\
        \ the `period` of the addon-item price. **Example** If the `period` of the\
        \ plan-item price is `2`, then the period of the addon-item price can be as\
        \ follows depending on the value of `period_unit`: * for `period_unit` as\
        \ `week`, `period` can be `2` or `1`. * for `period_unit` as `day`, `period`\
        \ can be `14`, `7`, `2`, or `1`.                            |\n| `month` \
        \                          | `month`                                     \
        \  | The `period` of the plan-item price should be divisible by the `period`\
        \ of the addon-item price. **Example** If the `period` of the plan-item price\
        \ is `6`, then the `period` of the addon-item price can be `6`, `3`, `2`,\
        \ or `1`.                                                                \
        \                                                                        \
        \                                                          |\n| `year`   \
        \                         | `year` or `month`                            \
        \ | The `period` (in months) of the plan-item price should be divisible by\
        \ the `period` of the addon-item price. **Example** If the `period` of the\
        \ plan-item price is `2`, then the `period` of the addon-item price can be\
        \ as follows depending on the value of `period_unit`: * for `period_unit`\
        \ as `year`, `period` can be `2` or `1`. * for `period_unit` as `month`, `period`\
        \ can be `24`, `12`, `8`, `6`, `4`, `3`, `2`, or `1`. |\n\n#### Tax provider\
        \ fields\n\n**Avalara** : Merchants using **Avalara Sales Tax** 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.  \n\
        \n|                                    Field ID                          \
        \          |                             Field Value                     \
        \         |                                      APIs                    \
        \                  |\n|--------------------------------------------------------------------------------|----------------------------------------------------------------------|--------------------------------------------------------------------------------|\n\
        | `locationCode`                                                         \
        \        | Merchant to configure it on Avalara Platform under company locations\
        \ | APIs having [Item Prices](/docs/api/item_prices/item-price-object) attributes.\
        \ |\n| APIs having [Item Prices](/docs/api/item_prices/item-price-object)\
        \ attributes. |\n| APIs having [Item Prices](/docs/api/item_prices/item-price-object)\
        \ attributes. |\n| APIs having [Item Prices](/docs/api/item_prices/item-price-object)\
        \ attributes. |\n\n**Anrok**: 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  \n\n|                           \
        \                                    Field ID                            \
        \                                    |                          Field Value\
        \                          |                                             \
        \                    APIs                                                \
        \                  |\n|---------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|\n\
        | `additionalTaxRegistrationNumber`                                      \
        \                                                               | Canadian\
        \ tax registration numbers in comma separated fashion. | APIs involving customer\
        \ attributes. Also includes APIs where we are creating new customers. Eg:\
        \ estimate, subscription, hosted pages. |\n| APIs involving customer attributes.\
        \ Also includes APIs where we are creating new customers. Eg: estimate, subscription,\
        \ hosted pages. |\n| APIs involving customer attributes. Also includes APIs\
        \ where we are creating new customers. Eg: estimate, subscription, hosted\
        \ pages. |\n| APIs involving customer attributes. Also includes APIs where\
        \ we are creating new customers. Eg: estimate, subscription, hosted pages.\
        \ |\n\n**Vertex**: Chargebee shares field IDs and corresponding values with\
        \ merchants, who then configure them on the Vertex Platform for seamless integration\
        \  \n**Note:**\nField Id like `customerCode`\n, `customerClass`\n, and`taxExempted`\n\
        belong to the customer object.\n\nField Id like `productCode`\n, `productClass`\n\
        , `productTaxCode`\n, and `productClass`\nbelong to the product object.  \n\
        \n|    Field ID     |                 Field Value                 |      \
        \                                                                        \
        \                                                                        \
        \                        APIs                                            \
        \                                                                        \
        \                                                          |\n|-----------------|---------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n\
        | `productCode`   | Merchant to configure it on Vertex Platform | APIs having\
        \ [Item Prices](/docs/api/item_prices/item-price-object) attributes.     \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                    |\n| `productClass` \
        \ | Merchant to configure it on Vertex Platform | APIs having [Item Prices](/docs/api/item_prices/item-price-object)\
        \ attributes.                                                            \
        \                                                                        \
        \                                                                        \
        \                                                                     |\n\
        | `customerCode`  | Merchant to configure it on Vertex Platform | APIs involving\
        \ [customer](/docs/api/customers/customer-object) attributes. Also includes\
        \ APIs where we are creating new customers. For example: [estimate](/docs/api/estimates/estimate-for-creating-a-customer-and-subscription),\
        \ [subscription](/docs/api/subscriptions), [hosted pages](/docs/api/hosted_pages/checkout-charge-items-and-one-time-charges).\
        \ |\n| `customerClass` | Merchant to configure it on Vertex Platform | APIs\
        \ involving [customer](/docs/api/customers/customer-object) attributes. Also\
        \ includes APIs where we are creating new customers. For example: [estimate](/docs/api/estimates/estimate-for-creating-a-customer-and-subscription),\
        \ [subscription](/docs/api/subscriptions), [hosted pages](/docs/api/hosted_pages/checkout-charge-items-and-one-time-charges).\
        \ |\n\n**Taxamo:** Chargebee shares field IDs and corresponding values with\
        \ merchants, who then configure them on the Taxamo Platform for seamless integration\
        \  \n\n|     Field Id     |                 Field Value                 |\
        \                                                                        \
        \                                                                        \
        \                              APIs                                      \
        \                                                                        \
        \                                                                |\n|------------------|---------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n\
        | `productTaxCode` | Merchant to configure it on Taxamo Platform | APIs having\
        \ [Item Prices](/docs/api/item_prices/item-price-object) attributes.     \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                    |\n| `productClass` \
        \  | Merchant to configure it on Taxamo Platform | APIs having [Item Prices](/docs/api/item_prices/item-price-object)\
        \ attributes.                                                            \
        \                                                                        \
        \                                                                        \
        \                                                                     |\n\
        | `taxExempted`    | Merchant to configure it on Taxamo Platform | APIs involving\
        \ [customer](/docs/api/customers/customer-object) attributes. Also includes\
        \ APIs where we are creating new customers. For example: [estimate](/docs/api/estimates/estimate-for-creating-a-customer-and-subscription),\
        \ [subscription](/docs/api/subscriptions), [hosted pages](/docs/api/hosted_pages/checkout-charge-items-and-one-time-charges).\
        \ |\n\n**cbtaxes**: 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.  \n\n|   Field ID    |  \
        \     Field Value       |                                                \
        \                                                                        \
        \                                                      APIs              \
        \                                                                        \
        \                                                                        \
        \                |\n|---------------|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n\
        | `indiaSez`    | `SEZ_IGST_TAX`          | APIs involving [customer](/docs/api/customers/customer-object)\
        \ attributes. Also includes APIs where we are creating new customers. For\
        \ example: [estimate](/docs/api/estimates/estimate-for-creating-a-customer-and-subscription),\
        \ [subscription](/docs/api/subscriptions), [hosted pages](/docs/api/hosted_pages/checkout-charge-items-and-one-time-charges).\
        \ |\n| `indiaSez`    | `SEZ_ZERO_RATED_TAX`    | APIs involving [customer](/docs/api/customers/customer-object)\
        \ attributes. Also includes APIs where we are creating new customers. For\
        \ example: [estimate](/docs/api/estimates/estimate-for-creating-a-customer-and-subscription),\
        \ [subscription](/docs/api/subscriptions), [hosted pages](/docs/api/hosted_pages/checkout-charge-items-and-one-time-charges).\
        \ |\n| `indiaExport` | `EXPORT_IGST_TAX`       | APIs involving [customer](/docs/api/customers/customer-object)\
        \ attributes. Also includes APIs where we are creating new customers. For\
        \ example: [estimate](/docs/api/estimates/estimate-for-creating-a-customer-and-subscription),\
        \ [subscription](/docs/api/subscriptions), [hosted pages](/docs/api/hosted_pages/checkout-charge-items-and-one-time-charges).\
        \ |\n| `indiaExport` | `EXPORT_ZERO_RATED_TAX` | APIs involving [customer](/docs/api/customers/customer-object)\
        \ attributes. Also includes APIs where we are creating new customers. For\
        \ example: [estimate](/docs/api/estimates/estimate-for-creating-a-customer-and-subscription),\
        \ [subscription](/docs/api/subscriptions), [hosted pages](/docs/api/hosted_pages/checkout-charge-items-and-one-time-charges).\
        \ |\n\n**All**: For tax inclusive tax calculation, For tax exclusive tax calculation.\
        \ This is currently used for price type overriding at customer level  \n\n\
        |  Field ID   |       Field Value       |                                \
        \                                                                        \
        \                                                                      APIs\
        \                                                                        \
        \                                                                        \
        \                              |\n|-------------|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n\
        | `priceType` | `TAX_INCLUSIVE`         | APIs involving [customer](/docs/api/customers/customer-object)\
        \ attributes. Also includes APIs where we are creating new customers. For\
        \ example: [estimate](/docs/api/estimates/estimate-for-creating-a-customer-and-subscription),\
        \ [subscription](/docs/api/subscriptions), [hosted pages](/docs/api/hosted_pages/checkout-charge-items-and-one-time-charges).\
        \ |\n|             | `TAX_EXCLUSIVE`         |                           \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                     |\n|             | `SITE_DEFAULT` or\
        \ blank | Removes price type override, and allows site level configuration\
        \ to be used for tax calculation.                                        \
        \                                                                        \
        \                                                                        \
        \                                                                       |\n\
        \n#### Ramps API compatibility mode\n\nIf you want to schedule changes on\
        \ a subscription, use the [Ramps API](/docs/api/ramps).\n\nIf you are currently\
        \ scheduling changes through the [Update subscription API](/docs/api/subscriptions/update-subscription-for-items),\
        \ migrate to the Ramps API. To get started, [request access for Subscription\
        \ Ramps](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/subscription-ramps&ref=feature).\
        \ Chargebee will enable Ramps compatibility mode for your site. Once enabled,\
        \ you can test the Ramps API without impacting your existing integrations.\n\
        \nThe following parts of the Billing API have subtle differences in behavior\
        \ when the Ramps feature is disabled versus when it is enabled with compatibility\
        \ mode. (Follow the links to learn more.)\n\n* The value of the [`subscription.has_scheduled_changes`](/docs/api/subscriptions/subscription-object#has_scheduled_changes)\
        \ attribute.\n* [Update subscription](/docs/api/subscriptions/update-subscription-for-items#impact-scheduled-changes)\n\
        * [Create Checkout for updating a subscription](/docs/api/hosted_pages/create-checkout-to-update-a-subscription#impact-scheduled-changes)\n\
        * [Remove scheduled changes](/docs/api/subscriptions/remove-scheduled-changes)\n\
        * [Retrieve with scheduled changes](/docs/api/subscriptions/retrieve-with-scheduled-changes)\n\
        * [Create a quote for updating a subscription](/docs/api/quotes/create-a-quote-for-update-subscription-items)\n\
        * [Edit a quote for updating a subscription](/docs/api/quotes/edit-update-subscription-quote-for-items)\n\
        * [Portal sessions](/docs/api/portal_sessions#scheduled-subscription-changes)\n"
      properties:
        id:
          type: string
          deprecated: false
          description: "The unique identifier of the `subscription`\nresource. You\
            \ have the option to specify this value when creating a customer. If not\
            \ specified, Chargebee automatically generates a unique identifier.  \n\
            **Note**\nIn the event that the subscription resource is [transferred](/docs/api/business_entities/transfer-resources-to-another-business-entity)\
            \ along with its associated [customer](/docs/api/customers) resource to\
            \ a different business entity, Chargebee assigns a new random value as\
            \ the `id` for the subscription. The original identifier is preserved\
            \ for the transferred copy of the `subscription` resource. (See also:\
            \ [Mechanics of business entity transfer](/docs/api/business_entities).)\n"
          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
        billing_period:
          type: integer
          format: int32
          deprecated: false
          description: |
            Specifies the length of each billing cycle (or term) of the subscription, expressed in the unit defined by `billing_period_unit`.
          minimum: 1
          example: null
        billing_period_unit:
          type: string
          deprecated: false
          description: |
            Specifies the unit used to measure 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/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/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
        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 `transferred`
              status will be reflected on the source business entity's subscription attribute once the [customer transfer](https://www.chargebee.com/docs/2.0/mbe-getting-started-with-customer-transfer.html)
              activity is completed successfully.
            * 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
        trial_start:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Start 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
        trial_end_action:
          type: string
          deprecated: false
          description: |
            Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/2.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/2.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/2.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: |
            The date/time at which the next billing for the subscription happens. This is usually right after `current_term_end`
            unless multiple subscription terms were invoiced in advance using the `terms_to_charge`
            parameter.
          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: |
            Time at which the subscription was started. Is `null`
            for `future`
            subscriptions as it is yet to be started.
          example: null
        activated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Time at which the subscription `status`
            last changed to
            `active`.
            For example, this value is updated when an `in_trial`
            or
            `cancelled`
            subscription activates.
          example: null
        contract_term_billing_cycle_on_renewal:
          type: integer
          format: int32
          deprecated: false
          description: |
            Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as `billing_cycles`
            or a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)
            .
          maximum: 100
          minimum: 1
          example: null
        override_relationship:
          type: boolean
          deprecated: false
          description: |
            If `true`
            , ignores the [hierarchy relationship](/docs/api/customers/customer-object#relationship)
            and uses customer as payment and invoice owner.
          example: null
        pause_date:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            When a pause has been scheduled, it is the date/time of scheduled pause. When the subscription is in the `paused`
            state, it is the date/time when the subscription was paused.
          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
        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: |
            Version number of this resource. The `resource_version`
            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.
          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: "Indicates whether a change is scheduled on the subscription.\
            \  \n**Note**\nWhen [Ramps](ramps) are enabled with compatibility mode,\
            \ this attribute indicates whether one or more ramps are scheduled for\
            \ the subscription. For more details, see [Ramps API compatibility mode](/docs/api/subscriptions#ramps-compat-mode).\n"
          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/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/currencies)
            is enabled.
          maxLength: 39
          example: null
        cancel_schedule_created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            This is the date/time at which the most recent cancellation schedule for the subscription was created in Chargebee. Applicable only for `cancelled`
            subscriptions or subscriptions that are scheduled for cancellation.
          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.

            * 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.
            * 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.
          enum:
          - web
          - app_store
          - play_store
          example: null
        net_term_days:
          type: integer
          format: int32
          deprecated: false
          description: |
            The [Net D](https://www.chargebee.com/docs/net_d.html)
            value explicitly set for this subscription. Net D is the number of days from [`invoice.date`](/docs/api/invoices/invoice-object#date) until payment for the invoice is due. When an invoice is raised, and this value is unavailable, the net_term_days defined at [the customer level](/docs/api/customers/customer-object#net_term_days)
            is considered.
          example: null
        active_id:
          type: string
          deprecated: false
          description: "**Note** : Present only when the `subscription` has been [transferred](/docs/api/business_entities/transfer-resources-to-another-business-entity)\
            \ between business entities.\n\nRepresents the `id` of the active version\
            \ of the `subscription` resource.  \n**Tip**\nIf the `id` and `active_id`\
            \ of a `subscription` resource are the same, this indicates that you are\
            \ working with the active version of that `subscription` resource.\n"
          maxLength: 50
          example: null
        due_invoices_count:
          type: integer
          format: int32
          deprecated: false
          description: |
            Total number of invoices that are due for payment against the subscription.
            **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. It is also worth noting that the consolidated invoice amount is not included in the calculation of `due_invoices_count`
            .
          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: |
            Total invoice due amount for this subscription. The value depends on the [type of currency](/docs/api/subscriptions)
            .
            **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. It is also worth noting that the consolidated invoice amount is not included in the calculation of `total_dues`
            .
          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.  \n**Note:**\nThere's a character limit of 65,535.\n\
            \n[Learn more](/docs/api/advanced-features#metadata)\n.\n"
          example: null
        deleted:
          type: boolean
          deprecated: false
          description: |
            Indicates that the subscription has been deleted when the value is `true`.
            You can retrieve a deleted subscription using the [list operation](/docs/api/subscriptions/list-subscriptions)
            .
          example: null
        changes_scheduled_at:
          type: integer
          format: unix-time
          deprecated: false
          description: "The date-time at which the subscription change is scheduled\
            \ to happen.  \n**Note**\nThis attribute is not returned when the change\
            \ is scheduled to happen at the end of the current term.\n"
          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 extended free of charge. The value is expressed in the time unit specified by `free_period_unit`. For example, `3` with `free_period_unit` = `month` means 3 free months are added to the first term.
          example: null
        free_period_unit:
          type: string
          deprecated: false
          description: |
            The time unit for `free_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: |
            Indicates whether the invoices for this subscription are generated with a `pending` `status`. This attribute is set to `true` automatically when the subscription has item prices that belong to `metered` items.
            You can also set this to `true` explicitly using the [create](/docs/api/subscriptions/create-subscription-for-items#create_pending_invoices)/[update](/docs/api/subscriptions/update-subscription-for-items#create_pending_invoices) subscription operations. This is useful in the following scenarios:

            * When tracking usages and calculating usage-based charges on your end. You can then add them to the subscription as a [one-time charge](https://www.chargebee.com/docs/charges.html) at the end of the billing term.
            * When you need to inspect all charges before closing invoices for this subscription. Applicable only when [Metered Billing](https://www.chargebee.com/docs/metered_billing.html) is enabled for the site
          example: null
        auto_close_invoices:
          type: boolean
          deprecated: false
          description: |
            Set to `false`
            to override for this subscription, the [site-level setting](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing)
            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 [customer level](/docs/api/customers/customer-object#auto_close_invoices)
            .
          example: null
        business_entity_id:
          type: string
          deprecated: false
          description: |
            The unique ID of the [business entity](/docs/api/advanced-features)
            of this subscription. This is always the same as the [business entity](/docs/api/subscriptions/subscription-object#customer_id)
            of the customer.
          maxLength: 50
          example: null
        decommissioned:
          type: boolean
          default: false
          deprecated: false
          description: "Indicates whether the subscription has been [decommissioned](/docs/api/subscriptions/cancel-subscription-for-items#decommissioned).\
            \ If set to `true` all subscription operations are disabled except deletion.\
            \  \n**Note** : Decommission operation is irreversible. Once set to `true`\
            \ it cannot be updated to `false` and thus subscription will remain decommissioned\
            \ permanently.\n"
          example: null
        brand_id:
          type: string
          deprecated: false
          description: |
            The unique ID of the [brand](/docs/api/brands) this subscription belongs to. This is the brand of the customer the subscription was created for, unless a different brand was specified in the create request.
          maxLength: 50
          example: null
        subscription_items:
          type: array
          deprecated: false
          description: |
            Details of individual [item prices](/docs/api/item_prices)
            that are part of this subscription.
          items:
            type: object
            deprecated: false
            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: |
                  The type of item. There must be one and only one item of type `plan`
                  in this list.

                  * plan - Plan
                  * charge - Charge
                  * addon - Addon
                enum:
                - plan
                - addon
                - charge
                example: null
              quantity:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The quantity of the item purchased
                minimum: 1
                example: null
              quantity_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)
                  is enabled.
                maxLength: 33
                example: null
              unit_price:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The price/per unit price of the item. When not provided, [the value set](/docs/api/item_prices/item-price-object)
                  for the item price is used. This is only applicable when the `pricing_model`
                  of the item price is `flat_fee`
                  or `per_unit`.
                  Also, it is only allowed when [price overriding](https://www.chargebee.com/docs/price-override.html)
                  is enabled for the site. The value depends on the type of currency. If `changes_scheduled_at`
                  is in the past and a `unit_price`
                  is not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
                minimum: 0
                example: null
              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/getting-started)
                  is enabled.
                maxLength: 39
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The total amount for the item as determined from `unit_price`
                  , `free_quantity`
                  , `quantity`
                  and `item_tiers`
                  as applicable. The value depends on the [type of currency](/docs/api/currencies)
                  .
                minimum: 0
                example: null
              current_term_start:
                type: integer
                format: unix-time
                deprecated: false
                description: "The beginning of the item's current billing period.\
                  \  \n**Note**\nApplicable only when multi-frequency billing is [enabled](https://www.chargebee.com/docs/billing/2.0/subscriptions/multi-frequency-billing#enable-multi-frequency-billing).\n"
                example: null
              current_term_end:
                type: integer
                format: unix-time
                deprecated: false
                description: "The end of the item's current billing period. Chargebee\
                  \ renews the item immediately following this date.  \n**Note**\n\
                  Applicable only when multi-frequency billing is [enabled](https://www.chargebee.com/docs/billing/2.0/subscriptions/multi-frequency-billing#enable-multi-frequency-billing).\n"
                example: null
              next_billing_at:
                type: integer
                format: unix-time
                deprecated: false
                description: "The date or time at when the next billing for the item\
                  \ is scheduled to occur. This typically occurs immediately after\
                  \ `current_term_end`.  \n**Note**\nApplicable only when multi-frequency\
                  \ billing is [enabled](https://www.chargebee.com/docs/billing/2.0/subscriptions/multi-frequency-billing#enable-multi-frequency-billing).\n"
                example: null
              amount_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the total amount for the item, in major units of the currency. Always returned when [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 39
                example: null
              billing_period:
                type: integer
                format: int32
                deprecated: false
                description: "Specifies the length of each billing cycle for this\
                  \ subscription item, expressed in the unit defined by `subscription_items.billing_period_unit`.\
                  \  \n\n**Returned only if**\n[Multi-Frequency Billing](https://www.chargebee.com/docs/billing/2.0/subscriptions/subscriptions#multi-frequency-billing)\
                  \ is enabled.\n\n\n"
                minimum: 1
                example: null
              billing_period_unit:
                type: string
                deprecated: false
                description: "Specifies the unit used to measure the `subscription_items.billing_period`.\
                  \  \n\n**Returned only if**\n[Multi-Frequency Billing](https://www.chargebee.com/docs/billing/2.0/subscriptions/subscriptions#multi-frequency-billing)\
                  \ is enabled.\n\n* year - A period of 1 calendar year.\n* week -\
                  \ A period of 7 days.\n* day - A period of 24 hours.\n* month -\
                  \ A period of 1 calendar month.\n"
                enum:
                - day
                - week
                - month
                - year
                example: null
              free_quantity:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The `free_quantity`
                  of the plan-item as [specified](/docs/api/item_prices)
                  for the item price.
                minimum: 0
                example: null
              free_quantity_in_decimal:
                type: string
                deprecated: false
                description: |
                  The `free_quantity_in_decimal`
                  as set for the item price. Returned for quantity-based item prices when [multi-decimal pricing](/docs/api/getting-started)
                  is enabled.
                maxLength: 33
                example: null
              trial_end:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  The date/time when the trial period of the item ends. Applies to plan-items and--when [enabled](https://www.chargebee.com/docs/2.0/addons-trial.html)
                  --addon-items as well.
                example: null
              billing_cycles:
                type: integer
                format: int32
                deprecated: false
                description: |
                  For the plan-item price:
                  the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then [the value set](/docs/api/item_prices/item-price-object)
                  for the plan-item price is used.

                  For addon-item prices:
                  If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)
                  are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then [the value set under attached addons](/docs/api/attached_items/attached-item-object)
                  is used. Further, if that value is not provided, then [the value set for the addon-item price](/docs/api/item_prices/item-price-object)
                  is used.
                minimum: 0
                example: null
              service_period_days:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The service period of the item in days from the day of charge.
                maximum: 730
                minimum: 1
                example: null
              charge_on_event:
                type: string
                deprecated: false
                description: |
                  When `charge_on_option`
                  option is set to `on_event`
                  , this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.

                  * contract_termination -
                    when a contract term is [terminated](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option)
                    .
                  * subscription_trial_start - the time when the trial period of the subscription begins.
                  * subscription_activation -
                    the moment a subscription enters an `active`
                    or `non-renewing`
                    state. Also includes reactivations of canceled subscriptions.
                  * plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
                  * subscription_creation - the time of creation of the subscription.
                enum:
                - subscription_creation
                - subscription_trial_start
                - plan_activation
                - subscription_activation
                - contract_termination
                example: null
              charge_once:
                type: boolean
                deprecated: false
                description: |
                  Indicates if the charge-item is to be charged only once or each time the `charge_on_event`
                  occurs. This parameter only applies to charge-items.
                example: null
              charge_on_option:
                type: string
                deprecated: false
                description: |
                  Indicates when the charge-item is to be charged. This parameter only applies to charge-items.

                  * immediately - The item is charged immediately on being added to the subscription.
                  * on_event -
                    The item is charged at the occurrence of the event specified as `charge_on_event`
                    .
                enum:
                - immediately
                - on_event
                example: null
              proration_type:
                type: string
                deprecated: false
                description: "Specifies how to manage charges or credits for the addon\
                  \ during a subscription update.\n\nYou can't modify this parameter's\
                  \ value within the current term. Moreover, it is removed from the\
                  \ subscription attributes when the next term starts.  \n**See also:**\n\
                  `subscription_items[proration_type]`\nparameter for [Update a subscription\
                  \ API](/docs/api/subscriptions/update-subscription-for-items#subscription_items_proration_type)\n\
                  .\n\n* none - Don't apply any charges or credits for the addon.\n\
                  * full_term - Charge the full price of the addon or give the full\
                  \ credit. Don't apply any proration.\n* partial_term - Prorate the\
                  \ charges or credits from the time of the change till the end of\
                  \ the current term.\n"
                enum:
                - full_term
                - partial_term
                - none
                example: null
              usage_accumulation_reset_frequency:
                type: string
                deprecated: false
                description: |
                  Specifies the frequency at which the usage counter needs to be reset.

                  * subscription_billing_frequency - Accumulates usage until the subscription's billing frequency ends.
                  * never - Accumulates usage without ever resetting it.
                enum:
                - never
                - subscription_billing_frequency
                example: null
              description:
                type: string
                deprecated: false
                description: |
                  **Limited availability**

                  Subscription-level item descriptions are available only on sites where this feature is enabled. Please reach out to the 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.

                  The description stored for this item on this subscription. It is used on the customer-facing invoice instead of the description configured for the item price, and is returned as `entity_description` on the invoice [line item](/docs/api/invoices/invoice-object#invoice_line_items).

                  This attribute is returned only when a description has been stored for the item on this subscription. When it is absent, the description configured for the item price applies. Whether a description is shown on the invoice at all continues to be controlled by the item price's [show_description_in_invoices](/docs/api/item_prices#show_description_in_invoices) setting.
                maxLength: 500
                example: null
            required:
            - item_price_id
            - item_type
            example: null
          example: null
        item_tiers:
          type: array
          deprecated: false
          description: |
            The pricing details of `subscription_items`
            which have [pricing_model](/docs/api/item_prices/item_price-object#pricing_model)
            as
            `tiered`
            , `volume`
            or `stairstep`
            .
          items:
            type: object
            deprecated: false
            properties:
              item_price_id:
                type: string
                deprecated: false
                description: |
                  The id of the item price to which this tier belongs.
                maxLength: 100
                example: null
              starting_unit:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The lowest value in the quantity tier.
                minimum: 1
                example: null
              ending_unit:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The highest value in the quantity tier.
                example: null
              price:
                type: integer
                format: int64
                default: 0
                deprecated: false
                description: |
                  The per-unit price for the tier when the `pricing_model`
                  is `tiered`
                  or `volume`.
                  The total cost for the item price when the `pricing_model`
                  is `stairstep`.
                  The value is in the minor unit of the currency.
                minimum: 0
                example: null
              starting_unit_in_decimal:
                type: string
                deprecated: false
                description: |
                  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 `ending_unit_in_decimal`
                  of the next lower tier. Returned only when the pricing_model is `tiered`
                  , `volume`
                  or `stairstep`
                  and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 33
                example: null
              ending_unit_in_decimal:
                type: string
                deprecated: false
                description: |
                  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 `starting_unit_in_decimal`
                  of the next higher tier. Returned only when the pricing_model is `tiered`
                  , `volume`
                  or `stairstep`
                  and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 33
                example: null
              price_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the per-unit price for the tier when the `pricing_model`
                  is `tiered`
                  or `volume`.
                  When the `pricing_model`
                  is `stairstep`
                  , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 39
                example: null
              pricing_type:
                type: string
                deprecated: false
                description: |
                  Pricing type for the tier.

                  * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                  * flat_fee -
                    Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                    pricing model, `pricing_type`
                    will be set to `flat_fee`
                    by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                  * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                enum:
                - per_unit
                - flat_fee
                - package
                example: null
              package_size:
                type: integer
                format: int32
                deprecated: false
                description: |
                  Package size for the tier when pricing type is `package`.
                  Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                minimum: 1
                example: null
              index:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The index number of the subscription to which the item price is added. Provide a unique number between `0`
                  and `4`
                  (inclusive) for each subscription that is to be created.
                minimum: 0
                example: null
            required:
            - index
            - item_price_id
            - price
            - starting_unit
            example: null
          example: null
        charged_items:
          type: array
          deprecated: false
          description: |
            List of event based charge items that have already been charged.
          items:
            type: object
            deprecated: false
            properties:
              item_price_id:
                type: string
                deprecated: false
                description: |
                  A unique ID for your system to identify the item price.
                maxLength: 100
                example: null
              last_charged_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Timestamp indicating when this charge item_price was last charged for this subscription.
                example: null
            required:
            - item_price_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: |
                  The date till when the coupon can be applied. Applicable for `limited_period`
                  [coupons](/docs/api/coupons)
                  only.
                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: |
                The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search)
                without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`
                as `AZ`
                (not `US-AZ`
                ). For Tamil Nadu (India), set as `TN`
                (not `IN-TN`
                ). For British Columbia (Canada), set as `BC`
                (not `CA-BC`
                ). For Dubai (UAE), set as `DU`
                (not `AE-DU`
                ).
              maxLength: 50
              example: null
            state:
              type: string
              deprecated: false
              description: |
                The state/province name.
              maxLength: 50
              example: null
            country:
              type: string
              deprecated: false
              description: "The billing address country of the customer. Must be one\
                \ of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html)\n\
                .\n\n**Note**:\nIf you enter an invalid country code, the system will\
                \ return an error.  \n**Brexit**\n\nIf you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\
                \ in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\
                \ the Brexit configuration, then `XI` (the code for **United Kingdom\
                \ - Northern Ireland**) is available as an 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://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
        billing_override:
          type: object
          deprecated: false
          description: "Specify limits on how credits and excess payments are applied\
            \ to individual invoices for the subscription.  \n**Prerequisite**\n\n\
            * [Credit flexibility](https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/credit-notes#credits-flexibility)\
            \ must be enabled for the site.  \n**Constraints**\n\n* These limits do\
            \ not apply to [consolidated invoices](https://www.chargebee.com/docs/2.0/consolidated-invoicing.html).\n"
          properties:
            max_excess_payment_usage:
              type: integer
              format: int64
              deprecated: false
              description: |
                Maximum amount of [excess payments](/docs/api/customers/customer-object#excess_payments) that can be automatically applied to a single invoice associated with this subscription.

                **Supported values:**

                * `0`: Auto-application of excess payments is disabled for the subscription.
                * Any positive value: Maximum amount of excess payments that can be automatically applied to a single invoice for this subscription.

                When this attribute is absent, the [site-level Credit flexibility configuration](https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/credit-notes#credits-flexibility) applies.
              minimum: -1
              example: null
            max_refundable_credits_usage:
              type: integer
              format: int64
              deprecated: false
              description: |
                Maximum amount of [refundable credits](/docs/api/customers/customer-object#refundable_credits) that can be automatically applied to a single invoice associated with this subscription.

                **Supported values:**

                * `0`: Auto-application of refundable credits is disabled for the subscription.
                * Any positive value: Maximum amount of refundable credits that can be automatically applied to a single invoice for this subscription.

                When this attribute is absent, the [site-level Credit flexibility configuration](https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/credit-notes#credits-flexibility) applies.
              minimum: -1
              example: null
          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: |
                Action to be taken when the contract term completes.

                * renew_once -
                  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 [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).

                  * The `action_at_term_end` for the new contract term is set to `cancel`.
                * cancel - Contract term completes and subscription is canceled.
                * evergreen - Contract term completes and the subscription renews.
                * renew -
                  * Contract term completes and a new contract term is started for the number of billing cycles specified in [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal).
                  * The `action_at_term_end` for the new contract term is set to `renew`.
              enum:
              - renew
              - evergreen
              - cancel
              - renew_once
              example: null
            total_contract_value:
              type: integer
              format: int64
              default: 0
              deprecated: false
              description: |
                The sum of the [totals](/docs/api/invoices/invoice-object#total)
                of all the invoices raised as part of the contract term. For `active`
                contract terms, this is a predicted value. The value depends on the [type of currency](/docs/api/currencies).
                If the subscription was [imported](/docs/api/v2/pcv-1/subscriptions/import-a-subscription)
                with the contract term, then this value includes the value passed for `total_amount_raised`
                .
              minimum: 0
              example: null
            total_contract_value_before_tax:
              type: integer
              format: int64
              default: 0
              deprecated: false
              description: |
                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 `total_amount_raised_before_tax`
                is included in the calculation of the total contract value before tax. It's important to note that this value excludes any applicable taxes.
              minimum: 0
              example: null
            cancellation_cutoff_period:
              type: integer
              format: int32
              deprecated: false
              description: |
                The number of days before [`contract_end`](/docs/api/contract_terms/contract_term-object#contract_end)
                , 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.
              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: |
                The number of subscription billing cycles remaining after the current one for the contract term. This attribute is only returned for `active`
                contract terms.
              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
        discounts:
          type: array
          deprecated: false
          description: "List of [discounts](/docs/api/discounts)\ncurrently attached\
            \ to the subscription.  \n**Note**\n\n* Discounts of [duration_type](/docs/api/discounts/discount-object#duration_type)\
            \ `one_time` are removed from the list after a single application to the\
            \ subscription.\n* Discounts of `duration_type` `limited_period` are removed\
            \ from the list once the specified [period](/docs/api/discounts/discount-object#period)\
            \ expires since their attachment to the subscription.\n"
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                description: |
                  An immutable unique id for the discount. It is always auto-generated.
                maxLength: 50
                example: null
              invoice_name:
                type: string
                deprecated: false
                description: |
                  The name of the discount as it should appear on customer-facing pages and documents such as [invoices](/docs/api/invoices)
                  and [hosted pages](/docs/api/hosted_pages).
                  This is auto-generated based on the `type`
                  , `amount`
                  , and `currency_code`
                  of the discount. For example, it can be `10% off`
                  or `10$ off`
                  .
                maxLength: 100
                example: null
              type:
                type: string
                default: percentage
                deprecated: false
                description: |
                  The type of discount.
                  Possible value are:

                  * offer_quantity -
                    A specified number of units of the item price are offered for free. The number of free units is specified in `quantity`.
                    The `offer_quantity`
                    option is valid only when `apply_on`
                    is set to `each_specified_item`
                    and the [pricing_model](/docs/api/item_prices/item_price-object#pricing_model)
                    of the item price is `per_unit`
                    .
                  * percentage - The specified percentage will be given as discount.
                  * fixed_amount - The specified amount will be given as discount.
                enum:
                - fixed_amount
                - percentage
                - offer_quantity
                example: null
              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
              amount:
                type: integer
                format: int64
                deprecated: false
                description: |
                  The value of the discount. [The format of this value](/docs/api/currencies)
                  depends on the kind of currency.
                minimum: 0
                example: null
              quantity:
                type: integer
                format: int32
                deprecated: false
                description: |
                  Specifies the number of free units provided for the item, without affecting the total quantity sold. This parameter is applicable only when `discount.type`
                  is `offer_quantity`.
                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 discount. This is only applicable when `discount.type`
                  is `fixed_amount`
                  .
                maxLength: 3
                example: null
              duration_type:
                type: string
                default: forever
                deprecated: false
                description: |
                  Specifies the time duration for which this discount is attached to the subscription.

                  * 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 `period`
                    and `period_unit`
                    .
                  * forever -
                    The discount is attached to the subscription and applied on the invoices till it is [explicitly removed](/docs/api/subscriptions/update-subscription-for-items#discounts_operation_type)
                    .
                  * one_time -
                    The discount stays attached to the subscription till it is applied on an invoice **once**.
                    It is removed after that from the subscription.
                enum:
                - one_time
                - forever
                - limited_period
                example: null
              period:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The duration of time for which the discount is attached to the subscription, in `period_units`.
                  Applicable only when `duration_type`
                  is `limited_period`.
                minimum: 1
                example: null
              period_unit:
                type: string
                deprecated: false
                description: |
                  The unit of time for `period`.
                  Applicable only when `duration_type`
                  is `limited_period`.

                  * week - A period of 7 days.
                  * year - A period of 1 calendar year.
                  * day - A period of 24 hours.
                  * month - A period of 1 calendar month.
                enum:
                - day
                - week
                - month
                - year
                example: null
              included_in_mrr:
                type: boolean
                deprecated: false
                description: |
                  The discount is included in MRR calculations for your site. This attribute is only applicable when `duration_type`
                  is `one_time`
                  and when the [feature is enabled](https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation)
                  in Chargebee. Also, If the [site-level setting](https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation)
                  is to exclude one-time discounts from MRR calculations, this value is always returned `false`.
                example: null
              apply_on:
                type: string
                deprecated: false
                description: |
                  The amount on the invoice to which the discount is applied.

                  * invoice_amount -
                    The discount is applied to the invoice `sub_total`
                    .
                  * specific_item_price -
                    The discount is applied to the `invoice.line_item.amount`
                    that corresponds to the item price specified by `item_price_id`
                    .
                enum:
                - invoice_amount
                - specific_item_price
                example: null
              item_price_id:
                type: string
                deprecated: false
                description: |
                  The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id)
                  in the subscription to which the discount is to be applied. Relevant only when `apply_on`
                  = `specific_item_price`.
                maxLength: 100
                example: null
              created_at:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Timestamp indicating when this discount is created.
                example: null
              apply_till:
                type: integer
                format: unix-time
                deprecated: false
                description: |
                  Specifies till when the limited period discount is applicable. This attribute will be sent in the response only for `limited_period`
                  duration type discount.
                example: null
              applied_count:
                type: integer
                format: int32
                deprecated: false
                description: |
                  Specifies the number of times the discount has been applied.
                example: null
              coupon_id:
                type: string
                deprecated: false
                description: "Used to uniquely identify the coupon in your website/application\
                  \ and to integrate with Chargebee.  \n**Note:**\n\nWhen the coupon\
                  \ ID contains a special character; for example: `#`, the API returns\
                  \ an error. Make sure that you [encode](https://www.urlencoder.org/)\
                  \ the coupon ID in the path parameter before making an API call.\n"
                maxLength: 100
                example: null
              index:
                type: integer
                format: int32
                deprecated: false
                description: |
                  The index number of the subscription to which the item price is added. Provide a unique number between `0`
                  and `4`
                  (inclusive) for each subscription that is to be created.
                minimum: 0
                example: null
            required:
            - apply_on
            - coupon_id
            - created_at
            - duration_type
            - id
            - included_in_mrr
            - index
            - type
            example: null
          example: null
      required:
      - currency_code
      - customer_id
      - decommissioned
      - deleted
      - has_scheduled_advance_invoices
      - has_scheduled_changes
      - id
      - 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
    SubscriptionBusinessEntityChangedEvent:
      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:
            business_entity_transfer:
              $ref: "#/components/schemas/BusinessEntityTransfer"
            subscription:
              $ref: "#/components/schemas/Subscription"
          required:
          - business_entity_transfer
          - 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
    SubscriptionEntitlement:
      type: object
      description: "Overview\n--------\n\nThe subscription entitlement object represents\
        \ the entitlement a [subscription](/docs/api/subscriptions) holds for a [feature](/docs/api/features).\
        \ A subscription can have several subscription entitlements, each tied to\
        \ a specific feature.\n\nHow subscription entitlements are determined\n--------------------------------------------\n\
        \n### With subscription-level entitlement override\n\nWhen an [entitlement\
        \ override](/docs/api/entitlement_overrides) with `entity_type` set to `subscription`\
        \ is set for a subscription related to a feature, the subscription entitlement\
        \ takes on the [value](/docs/api/entitlement_overrides/entitlement_override-object#value)\
        \ of that override.  \n\n### Without entitlement overrides\n\nIf there is\
        \ no entitlement override for the subscription and feature, the subscription\
        \ entitlement is based on the [entitlements](/docs/api/entitlements) linked\
        \ to the [item prices](/docs/api/item_prices) within the [subscription items](/docs/api/subscriptions/subscription-object#subscription_items).\
        \ If an item price lacks an entitlement record for a particular feature, we\
        \ consider the entitlement (when available) of its parent [item](/docs/api/items).\n\
        \nThe method used to derive the subscription entitlement from these entitlements\
        \ follows specific rules determined by the feature [type](/docs/api/features/feature-object#type).\
        \ We outline and provide examples of these rules in the sections below:  \n\
        Switch feature  \n\n#### Summary {#switch-content}\n\nConsider a feature of\
        \ type `switch`. Consider also a subscription whose subscription items correspond\
        \ to item prices (or items) that have entitlements to the feature. Looking\
        \ at these entitlements, we first determine the entitlement value held by\
        \ each subscription item for this feature.\n\nIf the entitlement value for\
        \ the feature held by **any** of the subscription items is `true`, then the\
        \ subscription entitlement value is also set to `true`. Otherwise, the subscription\
        \ entitlement value is set to `false`.\n\n#### Example\n\n##### 1. Feature\
        \ record\n\nConsider the following [feature](/docs/api/features) record: \
        \ \n\n|        `id`        |  `type`  |                   `description`  \
        \                 |\n|--------------------|----------|---------------------------------------------------|\n\
        | `xero-integration` | `switch` | An integration with the Xero accounting\
        \ software. |\n[Table 1: Feature records.]\n\n##### 2. Entitlement records\n\
        \nConsider the following [entitlement](/docs/api/entitlements) records for\
        \ the `xero-integration` feature:  \n\n|      `entity_id`      | `entity_type`\
        \ | `value` |\n|-----------------------|---------------|---------|\n| `starter`\
        \             | `plan`        | `true`  |\n| `starter-monthly-usd` | `plan_price`\
        \  | `false` |\n| `plus`                | `addon`       | `true`  |\n[Table\
        \ 2: Entitlement records for the `xero-integration` feature.]\n\n##### 3.\
        \ Subscription-items records\n\nConsider that a [subscription](/docs/api/subscriptions)\
        \ with ID `AzZjAiTl1btqS2lEj` has the following `subscription_items[]` records:\
        \  \n\n| Index |    `item_price_id`    | `quantity` |\n|-------|-----------------------|------------|\n\
        | `0`   | `starter-monthly-usd` | `1`        |\n| `1`   | `plus-monthly-usd`\
        \    | `1`        |\n| `2`   | `installation-usd`    | `2`        |\n[Table\
        \ 3: Subscription-items records.]\n\n##### 4. Subscription-item entitlements\n\
        \nChargebee Billing now determines the entitlement held by each subscription\
        \ item based on the entitlements defined in Table 2. This is shown in Table\
        \ 4. For clarity, we've omitted the `quantity` column because it doesn't affect\
        \ features with type `switch`.  \n\n| Index |    `item_price_id`    |    \
        \                     Entitlement value (determined from Table 2)        \
        \                  |\n|-------|-----------------------|----------------------------------------------------------------------------------------------|\n\
        | `0`   | `starter-monthly-usd` | `false` (Matches the value of the plan price.)\
        \                                               |\n| `1`   | `plus-monthly-usd`\
        \    | `true` (Inherited from the addon `plus`, as no entitlement is defined\
        \ for this addon price.) |\n| `2`   | `installation-usd`    | None (No entitlement\
        \ defined for the charge item.)                                          \
        \ |\n[Table 4: Entitlement values for subscription-items.]\n\n##### 5. Determining\
        \ final subscription entitlements\n\n###### Case 1: Absence of a subscription-level\
        \ override\n\nIn this scenario, the **final entitlement** (`subscription_entitlement.value`)\
        \ for the `xero-integration` feature is set to `true` because at least one\
        \ subscription-item entitlement value is `true`.\n\n###### Case 2: With subscription-level\
        \ override\n\nSuppose there's an [entitlement override](/docs/api/entitlement_overrides)\
        \ added to the subscription for the feature, as shown below:  \n\n|     `entity_id`\
        \     | `entity_type`  |    `feature_id`    | `value` |\n|---------------------|----------------|--------------------|---------|\n\
        | `AzZjAiTl1btqS2lEj` | `subscription` | `xero-integration` | `false` |\n\
        [Table 5: Entitlement override record for the subscription and feature.]\n\
        \nGiven this override, the subscription's final entitlement value for the\
        \ `xero-integration` feature is set to `false`.  \nQuantity feature  \n\n\
        #### Summary {#quantity-content}\n\nConsider a feature of type `quantity`.\
        \ Consider also a subscription whose subscription items correspond to item\
        \ prices (or items) that have entitlements to the feature. Looking at these\
        \ entitlements, we first determine the entitlement value held by each subscription\
        \ item for this feature.\n\nIf the entitlement value for the feature held\
        \ by any of the subscription items is `unlimited`, then the subscription entitlement\
        \ value is also `unlimited`. Otherwise, the subscription entitlement value\
        \ is the sum of all the entitlement values of the subscription items.\n\n\
        #### Example\n\n##### 1. Feature record\n\nConsider the following feature\
        \ record:  \n\n|      `id`       |   `type`   |             `description`\
        \             |\n|-----------------|------------|---------------------------------------|\n\
        | `user_licenses` | `quantity` | The number of user licenses provided. |\n\
        [Table 6: Feature records.]\n\nSuppose that the feature has `feature.levels[]`\
        \ records as follows:  \n\n| `level` | `value`  | `is_unlimited` |\n|---------|----------|----------------|\n\
        | `0`     | `5`      | `false`        |\n| `1`     | `10`     | `false`  \
        \      |\n| `2`     | `20`     | `false`        |\n| `3`     | Not set. |\
        \ `true`         |\n[Table 7: Feature levels records.]\n\n##### 2. Entitlement\
        \ records\n\nConsider the following entitlement records for the `user_licenses`\
        \ feature:  \n\n|      `entity_id`      | `entity_type` |   `value`   |\n\
        |-----------------------|---------------|-------------|\n| `starter`     \
        \        | `plan`        | `10`        |\n| `starter-monthly-usd` | `plan_price`\
        \  | `unlimited` |\n| `plus`                | `addon`       | `5`        \
        \ |\n| `one-time`            | `charge`      | `5`         |\n[Table 8: Entitlement\
        \ records for the `user_licenses` feature.]\n\n##### 3. Subscription-items\
        \ records\n\nConsider that a subscription with ID `AzZjAiTl1btqS2lEj` has\
        \ the following `subscription_items[]` records:  \n\n| Index |    `item_price_id`\
        \    | `quantity` |\n|-------|-----------------------|------------|\n| `0`\
        \   | `starter-monthly-usd` | `5`        |\n| `1`   | `plus-monthly-usd` \
        \   | `10`       |\n| `2`   | `one-time-usd`        | `1`        |\n[Table\
        \ 9: Subscription-items records.]\n\n##### 4. Subscription-item entitlements\n\
        \nChargebee Billing now determines the entitlement held by each subscription\
        \ item based on the entitlements defined in Table 8. This is shown in Table\
        \ 10.  \n\n| Index |    `item_price_id`    | `quantity` |                \
        \        Entitlement value (determined from Table 8)                     \
        \   | Entitlement value subtotal (Entitlement value × `quantity`) |\n|-------|-----------------------|------------|-------------------------------------------------------------------------------------------|-------------------------------------------------------------|\n\
        | `0`   | `starter-monthly-usd` | `5`        | `unlimited` (Matches the value\
        \ of the plan price.)                                        | `unlimited`\
        \ (unlimited x 5)                                 |\n| `1`   | `plus-monthly-usd`\
        \    | `10`       | `5` (Inherited from the addon `plus`, as no entitlement\
        \ is defined for this addon price.) | `50` (5 x 10)                      \
        \                         |\n| `2`   | `one-time-usd`        | `1`       \
        \ | `5` (Inherited from the charge `one-time`.)                          \
        \                     | `5` (5 x 1)                                      \
        \           |\n[Table 10: Entitlement values for subscription-items.]\n\n\
        ##### 5. Determining final subscription entitlements\n\n###### Case 1: Absence\
        \ of a subscription-level override\n\nIn this scenario, the **final entitlement\
        \ value** (`subscription_entitlement.value`) for the `user_licenses` feature\
        \ is the total entitlement value from the last column in Table 10, which amounts\
        \ to (unlimited + 50 + 5) = `unlimited`.\n\n###### Case 2: With subscription-level\
        \ override\n\nSuppose there's an entitlement override added to the subscription\
        \ for the feature, as shown below:  \n\n|     `entity_id`     | `entity_type`\
        \  |  `feature_id`   | `value` |\n|---------------------|----------------|-----------------|---------|\n\
        | `AzZjAiTl1btqS2lEj` | `subscription` | `user_licenses` | `20`    |\n[Table\
        \ 11: Entitlement override record for the subscription and feature.]\n\nGiven\
        \ this override, the subscription's **final entitlement value** for the `user_licenses`\
        \ feature is set to `20`.  \nRange feature  \n\n#### Summary {#range-content}\n\
        \nConsider a feature of type `range`. Consider also a subscription whose subscription\
        \ items correspond to item prices (or items) that have entitlements to the\
        \ feature. Looking at these entitlements, we first determine the entitlement\
        \ value held by each subscription item for this feature.\n\nIf the entitlement\
        \ value for the feature held by any of the subscription items is `unlimited`,\
        \ then the subscription entitlement value is also `unlimited`. Otherwise,\
        \ one of two scenarios are possible:\n\n* If `feature.levels[1].is_unlimited`\
        \ is `true`, the subscription entitlement value equals the sum of all entitlement\
        \ values of the subscription items.\n\n* If `feature.levels[1].is_unlimited`\
        \ is `false`, the subscription entitlement value equals the sum of all entitlement\
        \ values of the subscription items without exceeding the maximum value of\
        \ `feature.level[1].value`.\n\n#### Example\n\n##### 1. Feature record\n\n\
        Consider the following feature record:  \n\n|       `id`       | `type`  |\
        \                     `description`                      |\n|------------------|---------|--------------------------------------------------------|\n\
        | `api_rate_limit` | `range` | The maximum number of API requests allowed\
        \ per minute. |\n[Table 12: Feature records.]\n\nSuppose that the feature\
        \ has `feature.levels[]` records as follows:  \n\n| `level` | `value` | `is_unlimited`\
        \ |\n|---------|---------|----------------|\n| `0`     | `100`   | `false`\
        \        |\n| `1`     | `1000`  | `false`        |\n[Table 13: Feature levels\
        \ records.]\n\n##### 2. Entitlement records\n\nConsider the following entitlement\
        \ records for the `api_rate_limit` feature:  \n\n|      `entity_id`      |\
        \ `entity_type` | `value` |\n|-----------------------|---------------|---------|\n\
        | `premium`             | `plan`        | `450`   |\n| `premium-monthly-usd`\
        \ | `plan_price`  | `400`   |\n| `plus`                | `addon`       | `150`\
        \   |\n[Table 14: Entitlement records for the `api_rate_limit` feature.]\n\
        \n##### 3. Subscription-items records\n\nConsider that a subscription with\
        \ ID `AzZjAiTl1btqS2lEj` has the following `subscription_items[]` records:\
        \  \n\n| Index |    `item_price_id`    | `quantity` |\n|-------|-----------------------|------------|\n\
        | `0`   | `premium-monthly-usd` | `2`        |\n| `1`   | `plus-monthly-usd`\
        \    | `2`        |\n[Table 15: Subscription-items records.]\n\n##### 4. Subscription-item\
        \ entitlements\n\nChargebee Billing now determines the entitlement held by\
        \ each subscription item based on the entitlements defined in Table 14. This\
        \ is shown in Table 16.  \n\n| `subscription_items[]` index |    `item_price_id`\
        \    | `quantity` |                        Entitlement value (determined from\
        \ Table 14)                         | Entitlement value subtotal (Entitlement\
        \ value x `quantity`) |\n|------------------------------|-----------------------|------------|---------------------------------------------------------------------------------------------|-------------------------------------------------------------|\n\
        | `0`                          | `premium-monthly-usd` | `2`        | `400`\
        \ (Matches the value of the plan price.)                                 \
        \               | `800` (400 x 2)                                        \
        \     |\n| `1`                          | `plus-monthly-usd`    | `2`    \
        \    | `150` (Inherited from the addon `plus`, as no entitlement is defined\
        \ for this addon price.) | `300` (150 x 2)                               \
        \              |\n[Table 16: Entitlement values for subscription-items.]\n\
        \n##### 5. Determining final subscription entitlements\n\n###### Case 1: `feature.levels[1].is_unlimited`\
        \ is `false`\n\nIn this scenario, the **final entitlement value** (`subscription_entitlement.value`)\
        \ for the `api_rate_limit` feature is the total entitlement value from the\
        \ last column in Table 16, capped at `feature.levels[1].value`. The total\
        \ entitlement value is 800 + 300 = 1100. However, `feature.levels[1].value`\
        \ is `1000`, which is less than 1100. Therefore, the final entitlement is\
        \ `1000`.\n\n###### Case 2: `feature.levels[1].is_unlimited` is `true`\n\n\
        In this scenario, `feature.levels[1].value` is disregarded, and the **final\
        \ entitlement value** is not capped. In other words, the final entitlement\
        \ value is `1100`.  \nCustom feature  \n\n#### Summary {#custom-content}\n\
        \nConsider a feature of type `custom`. Consider also a subscription whose\
        \ subscription items correspond to item prices (or items) that have entitlements\
        \ to the feature.\n\nLooking at these entitlements, we first determine the\
        \ entitlement value held by each subscription item for this feature. The subscription\
        \ entitlement value is then set to the highest of these identified values.\n\
        \n#### Example\n\n##### 1. Feature record\n\nConsider the following feature\
        \ record:  \n\n|   `id`    |  `type`  |                        `description`\
        \                        |\n|-----------|----------|-------------------------------------------------------------|\n\
        | `support` | `custom` | `The form of after-sales support provided to the\
        \ customer.` |\n[Table 17: Feature records.]\n\nSuppose that the feature has\
        \ `feature.levels[]` records as follows:  \n\n| `level` | `value` |\n|---------|---------|\n\
        | `0`     | `email` |\n| `1`     | `chat`  |\n| `2`     | `call`  |\n[Table\
        \ 18: Feature levels records.]\n\n##### 2. Entitlement records\n\nConsider\
        \ the following entitlement records for the `support` feature:  \n\n|    \
        \  `entity_id`      | `entity_type` | `value` |\n|-----------------------|---------------|---------|\n\
        | `starter`             | `plan`        | `chat`  |\n| `starter-monthly-usd`\
        \ | `plan_price`  | `email` |\n| `plus`                | `addon`       | `call`\
        \  |\n[Table 19: Entitlement records for the `api_rate_limit` feature.]\n\n\
        ##### 3. Subscription-items records\n\nConsider that a subscription with ID\
        \ `AzZjAiTl1btqS2lEj` has the following `subscription_items[]` records:  \n\
        \n| Index |    `item_price_id`    | `quantity` |\n|-------|-----------------------|------------|\n\
        | `0`   | `starter-monthly-usd` | `2`        |\n| `1`   | `plus-monthly-usd`\
        \    | `2`        |\n[Table 20: Subscription-items records.]\n\n##### 4. Subscription-item\
        \ entitlements\n\nChargebee Billing now determines the entitlement held by\
        \ each subscription item based on the entitlements defined in Table 19. This\
        \ is shown in Table 21. For clarity, we've omitted the `quantity` column because\
        \ it doesn't affect features with type `custom`.  \n\n| Index |    `item_price_id`\
        \    |                 Subscription-Item Entitlement Value (determined from\
        \ Table )                 |\n|-------|-----------------------|----------------------------------------------------------------------------------------------|\n\
        | `0`   | `starter-monthly-usd` | `email` (Matches the value of the plan price.)\
        \                                               |\n| `1`   | `plus-monthly-usd`\
        \    | `call` (Inherited from the addon `plus`, as no entitlement is defined\
        \ for this addon price.) |\n[Table 21: Entitlement values for subscription-items.]\n\
        \n##### 5. Determining final subscription entitlements\n\n###### Case 1: Absence\
        \ of a subscription-level override\n\nIn this scenario, the **final entitlement**\
        \ for the `support` feature is the **highest** of all the subscription-item\
        \ entitlement values, which in this case is `call`.\n\n###### Case 2: With\
        \ subscription-level override\n\nSuppose there's an entitlement override added\
        \ to the subscription for the feature, as shown below:  \n\n|     `entity_id`\
        \     | `entity_type`  | `feature_id` | `value` |                        \
        \ `expires_at`                          |\n|---------------------|----------------|--------------|---------|---------------------------------------------------------------|\n\
        | `AzZjAiTl1btqS2lEj` | `subscription` | `support`    | `chat`  | `1695884985`\
        \ (7 days from now, assuming today is 2023-09-21.) |\n[Table 22: Entitlement\
        \ override record for the subscription and feature.]\n\nGiven this override,\
        \ the subscription's **final entitlement value** for the `support` feature\
        \ will be `chat` until 2023-09-21 and `call` thereafter.  \n\n### With other\
        \ entity-level entitlement overrides\n\nWhen an [entitlement override](/docs/api/entitlement_overrides)\
        \ with `entity_type` set to `plan_price`, `addon_price`, or `charge` is set\
        \ for a subscription, the override affects the entitlement value used for\
        \ that specific entity when calculating subscription-item entitlements. If\
        \ an entitlement override exists for a plan price, addon price, or charge\
        \ entity, its value is used instead of the regular [entitlement](/docs/api/entitlements)\
        \ value for that entity.\n\nThe method used to derive the subscription entitlement\
        \ from these overridden values follows the same rules determined by the feature\
        \ [type](/docs/api/features/feature-object#type) as described in the sections\
        \ above. We outline and provide examples of these rules in the sections below:\
        \  \nSwitch feature  \n\n#### Summary {#switch-entity-override-content}\n\n\
        When calculating subscription-item entitlements for a feature of type `switch`,\
        \ if an entitlement override exists for a plan price, addon price, or charge\
        \ entity, the override's value is used instead of the regular entitlement\
        \ value for that entity. The final subscription entitlement value is then\
        \ determined using the same logic as described in the [Switch feature section](#switch):\
        \ if the entitlement value for the feature held by **any** of the subscription\
        \ items is `true`, then the subscription entitlement value is also set to\
        \ `true`. Otherwise, the subscription entitlement value is set to `false`.\n\
        \n#### Example\n\n##### 1. Feature record\n\nConsider the following [feature](/docs/api/features)\
        \ record:  \n\n|        `id`        |  `type`  |                    `description`\
        \                    |\n|--------------------|----------|-----------------------------------------------------|\n\
        | `xero-integration` | `switch` | `An integration with the Xero accounting\
        \ software.` |\n[Table 23: Feature records.]\n\n##### 2. Entitlement records\n\
        \nConsider the following [entitlement](/docs/api/entitlements) records for\
        \ the `xero-integration` feature:  \n\n|      `entity_id`      | `entity_type`\
        \ | `value` |\n|-----------------------|---------------|---------|\n| `starter`\
        \             | `plan`        | `true`  |\n| `starter-monthly-usd` | `plan_price`\
        \  | `false` |\n| `plus`                | `addon`       | `false` |\n[Table\
        \ 24: Entitlement records for the `xero-integration` feature.]\n\n##### 3.\
        \ Subscription-items records\n\nConsider that a [subscription](/docs/api/subscriptions)\
        \ with ID `AzZjAiTl1btqS2lEj` has the following `subscription_items[]` records:\
        \  \n\n| Index |    `item_price_id`    | `quantity` |\n|-------|-----------------------|------------|\n\
        | `0`   | `starter-monthly-usd` | `1`        |\n| `1`   | `plus-monthly-usd`\
        \    | `1`        |\n[Table 25: Subscription-items records.]\n\n##### 4. Entitlement\
        \ override records\n\nSuppose there's an [entitlement override](/docs/api/entitlement_overrides)\
        \ added to the subscription for the `plus-monthly-usd` addon price, as shown\
        \ below:  \n\n|    `entity_id`     | `entity_type` |    `feature_id`    |\
        \ `value` |\n|--------------------|---------------|--------------------|---------|\n\
        | `plus-monthly-usd` | `addon_price` | `xero-integration` | `true`  |\n[Table\
        \ 26: Entitlement override record for the addon price and feature.]\n\n#####\
        \ 5. Subscription-item entitlements\n\nChargebee Billing now determines the\
        \ entitlement held by each subscription item based on the entitlements defined\
        \ in Table 24, but uses the override value from Table 26 for the `plus-monthly-usd`\
        \ addon price. This is shown in Table 27. For clarity, we've omitted the `quantity`\
        \ column because it doesn't affect features with type `switch`.  \n\n| Index\
        \ |    `item_price_id`    |                                          Entitlement\
        \ value                                          |\n|-------|-----------------------|-----------------------------------------------------------------------------------------------------|\n\
        | `0`   | `starter-monthly-usd` | `false` (Matches the value of the plan price\
        \ entitlement.)                                          |\n| `1`   | `plus-monthly-usd`\
        \    | `true` (Uses the override value from Table 26 instead of inheriting\
        \ `false` from the addon `plus`.) |\n[Table 27: Entitlement values for subscription-items.]\n\
        \n##### 6. Determining final subscription entitlements\n\nIn this scenario,\
        \ the **final entitlement** for the `xero-integration` feature is set to `true`\
        \ because at least one subscription-item entitlement value is `true` (the\
        \ overridden value for `plus-monthly-usd`).  \nQuantity feature  \n\n####\
        \ Summary {#quantity-entity-override-content}\n\nWhen calculating subscription-item\
        \ entitlements for a feature of type `quantity`, if an entitlement override\
        \ exists for a plan price, addon price, or charge entity, the override's value\
        \ is used instead of the regular entitlement value for that entity. The final\
        \ subscription entitlement value is then determined using the same logic as\
        \ described in the [Quantity feature section](#quantity): if the entitlement\
        \ value for the feature held by any of the subscription items is `unlimited`,\
        \ then the subscription entitlement value is also `unlimited`. Otherwise,\
        \ the subscription entitlement value is the sum of all the entitlement values\
        \ of the subscription items.\n\n#### Example\n\n##### 1. Feature record\n\n\
        Consider the following feature record:  \n\n|      `id`       |   `type` \
        \  |             `description`             |\n|-----------------|------------|---------------------------------------|\n\
        | `user_licenses` | `quantity` | The number of user licenses provided. |\n\
        [Table 28: Feature records.]\n\nSuppose that the feature has `feature.levels[]`\
        \ records as follows:  \n\n| `level` | `value` | `is_unlimited` |\n|---------|---------|----------------|\n\
        | `0`     | `5`     | `false`        |\n| `1`     | `10`    | `false`    \
        \    |\n| `2`     | `20`    | `false`        |\n[Table 29: Feature levels\
        \ records.]\n\n##### 2. Entitlement records\n\nConsider the following entitlement\
        \ records for the `user_licenses` feature:  \n\n|      `entity_id`      |\
        \ `entity_type` | `value` |\n|-----------------------|---------------|---------|\n\
        | `starter`             | `plan`        | `10`    |\n| `starter-monthly-usd`\
        \ | `plan_price`  | `5`     |\n| `plus`                | `addon`       | `5`\
        \     |\n| `one-time`            | `charge`      | `5`     |\n[Table 30: Entitlement\
        \ records for the `user_licenses` feature.]\n\n##### 3. Subscription-items\
        \ records\n\nConsider that a subscription with ID `AzZjAiTl1btqS2lEj` has\
        \ the following `subscription_items[]` records:  \n\n| Index |    `item_price_id`\
        \    | `quantity` |\n|-------|-----------------------|------------|\n| `0`\
        \   | `starter-monthly-usd` | `2`        |\n| `1`   | `plus-monthly-usd` \
        \   | `3`        |\n| `2`   | `one-time-usd`        | `1`        |\n[Table\
        \ 31: Subscription-items records.]\n\n##### 4. Entitlement override records\n\
        \nSuppose there are [entitlement override](/docs/api/entitlement_overrides)\
        \ records added to the subscription for the plan price and charge, as shown\
        \ below:  \n\n|      `entity_id`      | `entity_type` |  `feature_id`   |\
        \ `value` |\n|-----------------------|---------------|-----------------|---------|\n\
        | `starter-monthly-usd` | `plan_price`  | `user_licenses` | `10`    |\n| `one-time`\
        \            | `charge`      | `user_licenses` | `10`    |\n[Table 32: Entitlement\
        \ override records for the plan price and charge.]\n\n##### 5. Subscription-item\
        \ entitlements\n\nChargebee Billing now determines the entitlement held by\
        \ each subscription item based on the entitlements defined in Table 30, but\
        \ uses the override values from Table 32 for the `starter-monthly-usd` plan\
        \ price and `one-time` charge. This is shown in Table 33.  \n\n| Index | \
        \   `item_price_id`    | `quantity` |                                    \
        \            Entitlement value                                           \
        \      | Entitlement value subtotal (Entitlement value × `quantity`) |\n|-------|-----------------------|------------|------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|\n\
        | `0`   | `starter-monthly-usd` | `2`        | `10` (Uses the override value\
        \ from Table 32 instead of the plan price entitlement value of `5`.)     \
        \            | `20` (10 x 2)                                             \
        \  |\n| `1`   | `plus-monthly-usd`    | `3`        | `5` (Inherited from the\
        \ addon `plus`, as no entitlement is defined for this addon price and no override\
        \ exists.) | `15` (5 x 3)                                                |\n\
        | `2`   | `one-time-usd`        | `1`        | `10` (Uses the override value\
        \ from Table 32 instead of the charge entitlement value of `5`.)         \
        \            | `10` (10 x 1)                                             \
        \  |\n[Table 33: Entitlement values for subscription-items.]\n\n##### 6. Determining\
        \ final subscription entitlements\n\nIn this scenario, the **final entitlement\
        \ value** for the `user_licenses` feature is the total entitlement value from\
        \ the last column in Table 33, which amounts to (20 + 15 + 10) = `45`.  \n\
        Range feature  \n\n#### Summary {#range-entity-override-content}\n\nWhen calculating\
        \ subscription-item entitlements for a feature of type `range`, if an entitlement\
        \ override exists for a plan price, addon price, or charge entity, the override's\
        \ value is used instead of the regular entitlement value for that entity.\
        \ The final subscription entitlement value is then determined using the same\
        \ logic as described in the [Range feature section](#range): if the entitlement\
        \ value for the feature held by any of the subscription items is `unlimited`,\
        \ then the subscription entitlement value is also `unlimited`. Otherwise,\
        \ one of two scenarios are possible:\n\n* If `feature.levels[1].is_unlimited`\
        \ is `true`, the subscription entitlement value equals the sum of all entitlement\
        \ values of the subscription items.\n\n* If `feature.levels[1].is_unlimited`\
        \ is `false`, the subscription entitlement value equals the sum of all entitlement\
        \ values of the subscription items without exceeding the maximum value of\
        \ `feature.level[1].value`.\n\n#### Example\n\n##### 1. Feature record\n\n\
        Consider the following feature record:  \n\n|       `id`       | `type`  |\
        \                     `description`                      |\n|------------------|---------|--------------------------------------------------------|\n\
        | `api_rate_limit` | `range` | The maximum number of API requests allowed\
        \ per minute. |\n[Table 34: Feature records.]\n\nSuppose that the feature\
        \ has `feature.levels[]` records as follows:  \n\n| `level` | `value` | `is_unlimited`\
        \ |\n|---------|---------|----------------|\n| `0`     | `100`   | `false`\
        \        |\n| `1`     | `1000`  | `false`        |\n[Table 35: Feature levels\
        \ records.]\n\n##### 2. Entitlement records\n\nConsider the following entitlement\
        \ records for the `api_rate_limit` feature:  \n\n|      `entity_id`      |\
        \ `entity_type` | `value` |\n|-----------------------|---------------|---------|\n\
        | `premium`             | `plan`        | `450`   |\n| `premium-monthly-usd`\
        \ | `plan_price`  | `400`   |\n| `plus`                | `addon`       | `150`\
        \   |\n[Table 36: Entitlement records for the `api_rate_limit` feature.]\n\
        \n##### 3. Subscription-items records\n\nConsider that a subscription with\
        \ ID `AzZjAiTl1btqS2lEj` has the following `subscription_items[]` records:\
        \  \n\n| Index |    `item_price_id`    | `quantity` |\n|-------|-----------------------|------------|\n\
        | `0`   | `premium-monthly-usd` | `2`        |\n| `1`   | `plus-monthly-usd`\
        \    | `2`        |\n[Table 37: Subscription-items records.]\n\n##### 4. Entitlement\
        \ override records\n\nSuppose there's an [entitlement override](/docs/api/entitlement_overrides)\
        \ added to the subscription for the addon price, as shown below:  \n\n|  \
        \  `entity_id`     | `entity_type` |   `feature_id`   | `value` |\n|--------------------|---------------|------------------|---------|\n\
        | `plus-monthly-usd` | `addon_price` | `api_rate_limit` | `300`   |\n[Table\
        \ 38: Entitlement override record for the addon price and feature.]\n\n#####\
        \ 5. Subscription-item entitlements\n\nChargebee Billing now determines the\
        \ entitlement held by each subscription item based on the entitlements defined\
        \ in Table 36, but uses the override value from Table 38 for the `plus-monthly-usd`\
        \ addon price. This is shown in Table 39.  \n\n| Index |    `item_price_id`\
        \    | `quantity` |                                        Entitlement value\
        \                                         | Entitlement value subtotal (Entitlement\
        \ value × `quantity`) |\n|-------|-----------------------|------------|--------------------------------------------------------------------------------------------------|-------------------------------------------------------------|\n\
        | `0`   | `premium-monthly-usd` | `2`        | `400` (Matches the value of\
        \ the plan price.)                                                     | `800`\
        \ (400 x 2)                                             |\n| `1`   | `plus-monthly-usd`\
        \    | `2`        | `300` (Uses the override value from Table 38 instead of\
        \ inheriting `150` from the addon `plus`.) | `600` (300 x 2)             \
        \                                |\n[Table 39: Entitlement values for subscription-items.]\n\
        \n##### 6. Determining final subscription entitlements\n\n###### Case 1: `feature.levels[1].is_unlimited`\
        \ is `false`\n\nIn this scenario, the **final entitlement value** for the\
        \ `api_rate_limit` feature is the total entitlement value from the last column\
        \ in Table 39, capped at `feature.levels[1].value`. The total entitlement\
        \ value is 800 + 600 = 1400. However, `feature.levels[1].value` is `1000`,\
        \ which is less than 1400. Therefore, the final entitlement is `1000`.\n\n\
        ###### Case 2: `feature.levels[1].is_unlimited` is `true`\n\nIn this scenario,\
        \ `feature.levels[1].value` is disregarded, and the **final entitlement value**\
        \ is not capped. In other words, the final entitlement value is `1400`.  \n\
        Custom feature  \n\n#### Summary {#custom-entity-override-content}\n\nWhen\
        \ calculating subscription-item entitlements for a feature of type `custom`,\
        \ if an entitlement override exists for a plan price, addon price, or charge\
        \ entity, the override's value is used instead of the regular entitlement\
        \ value for that entity. The final subscription entitlement value is then\
        \ determined using the same logic as described in the [Custom feature section](#custom):\
        \ the subscription entitlement value is set to the highest of the identified\
        \ subscription-item entitlement values.\n\n#### Example\n\n##### 1. Feature\
        \ record\n\nConsider the following feature record:  \n\n|   `id`    |  `type`\
        \  |                       `description`                       |\n|-----------|----------|-----------------------------------------------------------|\n\
        | `support` | `custom` | The form of after-sales support provided to the customer.\
        \ |\n[Table 40: Feature records.]\n\nSuppose that the feature has `feature.levels[]`\
        \ records as follows:  \n\n| `level` | `value` |\n|---------|---------|\n\
        | `0`     | `email` |\n| `1`     | `chat`  |\n| `2`     | `call`  |\n[Table\
        \ 41: Feature levels records.]\n\n##### 2. Entitlement records\n\nConsider\
        \ the following entitlement records for the `support` feature:  \n\n|    \
        \  `entity_id`      | `entity_type` | `value` |\n|-----------------------|---------------|---------|\n\
        | `starter`             | `plan`        | `chat`  |\n| `starter-monthly-usd`\
        \ | `plan_price`  | `email` |\n| `plus`                | `addon`       | `email`\
        \ |\n[Table 42: Entitlement records for the `support` feature.]\n\n##### 3.\
        \ Subscription-items records\n\nConsider that a subscription with ID `AzZjAiTl1btqS2lEj`\
        \ has the following `subscription_items[]` records:  \n\n| Index |    `item_price_id`\
        \    | `quantity` |\n|-------|-----------------------|------------|\n| `0`\
        \   | `starter-monthly-usd` | `2`        |\n| `1`   | `plus-monthly-usd` \
        \   | `2`        |\n[Table 43: Subscription-items records.]\n\n##### 4. Entitlement\
        \ override records\n\nSuppose there's an [entitlement override](/docs/api/entitlement_overrides)\
        \ added to the subscription for the addon price, as shown below:  \n\n|  \
        \  `entity_id`     | `entity_type` | `feature_id` | `value` |\n|--------------------|---------------|--------------|---------|\n\
        | `plus-monthly-usd` | `addon_price` | `support`    | `call`  |\n[Table 44:\
        \ Entitlement override record for the addon price and feature.]\n\n##### 5.\
        \ Subscription-item entitlements\n\nChargebee Billing now determines the entitlement\
        \ held by each subscription item based on the entitlements defined in Table\
        \ 42, but uses the override value from Table 44 for the `plus-monthly-usd`\
        \ addon price. This is shown in Table 45. For clarity, we've omitted the `quantity`\
        \ column because it doesn't affect features with type `custom`.  \n\n| Index\
        \ |    `item_price_id`    |                                 Subscription-Item\
        \ Entitlement Value                                 |\n|-------|-----------------------|-----------------------------------------------------------------------------------------------------|\n\
        | `0`   | `starter-monthly-usd` | `email` (Matches the value of the plan price.)\
        \                                                      |\n| `1`   | `plus-monthly-usd`\
        \    | `call` (Uses the override value from Table 44 instead of inheriting\
        \ `email` from the addon `plus`.) |\n[Table 45: Entitlement values for subscription-items.]\n\
        \n##### 6. Determining final subscription entitlements\n\nIn this scenario,\
        \ the **final entitlement** for the `support` feature is the **highest** of\
        \ all the subscription-item entitlement values, which in this case is `call`\
        \ (the overridden value for `plus-monthly-usd`).\n"
      properties:
        subscription_id:
          type: string
          deprecated: false
          description: |
            The unique identifier of the [subscription](/docs/api/subscriptions)
            .
          maxLength: 50
          example: null
        feature_id:
          type: string
          deprecated: false
          description: |
            The unique identifier of the [feature](/docs/api/features)
            .
          maxLength: 50
          example: null
        feature_name:
          type: string
          deprecated: false
          description: |
            The [name of the feature](/docs/api/features/feature-object#name)
            .
          maxLength: 50
          example: null
        feature_unit:
          type: string
          deprecated: false
          description: |
            [The unit of measure](/docs/api/features/feature-object#unit)
            for the feature when its `type`
            is either `quantity`
            or `range`
            .
          maxLength: 50
          example: null
        feature_type:
          type: string
          deprecated: false
          description: |
            Specifies the [type of the feature](/docs/api/features/feature-object#type)
            associated with the granted subscription entitlement.
          maxLength: 50
          example: null
        value:
          type: string
          deprecated: false
          description: "The value denoting the final entitlement level that the subscription\
            \ holds for the feature.  \n**See also:**\n[How subscription entitlements\
            \ are determined](/docs/api/subscription_entitlements).\n"
          maxLength: 50
          example: null
        name:
          type: string
          deprecated: false
          description: |
            The display name of the final entitlement level that the subscription holds for the feature. It is derived based on the `type`
            of feature as follows: - When `feature.type` is `range` or `quantity`: the `name` is the space-separated concatenation of `value` and the pluralized form of `feature_unit`. For example, if `value` is `20` and `feature_unit` is `user`, then `name` becomes `20 users`.

            * When `feature.type` is `custom`: the `name` is the same as `value`.
            * When `feature.type` is `switch`: `name` is set to `Available` when `value` is `true`; it's set to `Not Available` when `value` is `false`.
          maxLength: 50
          example: null
        is_overridden:
          type: boolean
          deprecated: false
          description: |
            Indicates whether the entitlement held by the subscription for the feature is overridden via an [entitlement_overrides](/docs/api/entitlement_overrides)
            record.
          example: null
        is_enabled:
          type: boolean
          deprecated: false
          description: |
            Indicates that `components.is_enabled`
            exists.
          example: null
        expires_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp when the subscription entitlements are going to expire.
          example: null
        components:
          type: object
          deprecated: false
          description: |
            The component entitlements that constitute this `subscription_entitlement`.
            The effective entitlement [value](/docs/api/subscription_entitlements/subscription_entitlement-object#value)
            and [name](/docs/api/subscription_entitlements/subscription_entitlement-object#name)
            are determined from these component entitlements.
          properties:
            entitlement_overrides:
              type: object
              deprecated: false
              description: |
                When a subscription entitlement has been explicitly overridden, this object contains the details of said override. An `entitlement_override`
                can be [temporary](/docs/api/entitlement_overrides/entitlement_override-object#expires_at)
                such that it expires at some point in time and is no longer returned.
              properties:
                value:
                  type: string
                  deprecated: false
                  description: |+
                    The level of entitlement that the subscription has towards the feature. The possible values depend on the value of `feature.type`
                    :

                    * When `feature.type` is `custom`: The value can be any one of `levels[].value`.

                    * When `feature.type` is `switch`: This value is `true`.

                    * When `feature.type` is `quantity`:

                    * When `levels[].is_unlimited` is not `true`: The value can be any one of `levels[].value`.

                    * When `levels[].is_unlimited` is `true`: The value can also be any one of `levels[].value` or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.

                    * When `feature.type` is `range`:

                    * When `levels[].is_unlimited` is not `true`: The value can be any whole number between `levels[0].value` and `levels[1].value` (inclusive).

                    * When `levels[].is_unlimited` is `true`: The value can be any whole number equal to or greater than `levels[0].value` or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.

                  maxLength: 50
                  example: null
                name:
                  type: string
                  deprecated: false
                  description: |
                    A case-sensitive name for the subscription entitlement override. If it was not provided while creating this subscription entitlement override, then it is derived based on the `feature.type`
                    as follows:

                    * When `feature.type` is `range` or `quantity`: the `name` is the space-separated concatenation of value and the pluralized form of `feature_unit`. For example, if `value` is `20` and `feature_unit` is `user`, then `name` becomes `20 users`.
                    * When `feature.type` is `custom`: the `name` is the same as `value`.
                    * When `feature.type` is `switch`: `name` is not applicable.
                  maxLength: 50
                  example: null
              example: null
          example: null
      required:
      - is_enabled
      - is_overridden
      - subscription_id
      example: null
    SubscriptionEntitlementsCreatedDetail:
      type: object
      properties:
        subscription_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        has_next:
          type: boolean
          deprecated: false
          example: null
      required:
      - has_next
      example: null
    SubscriptionEntitlementsCreatedEvent:
      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_entitlements_created_detail:
              $ref: "#/components/schemas/SubscriptionEntitlementsCreatedDetail"
          required:
          - subscription_entitlements_created_detail
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionEntitlementsUpdatedDetail:
      type: object
      properties:
        subscription_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        has_next:
          type: boolean
          deprecated: false
          example: null
      required:
      - has_next
      example: null
    SubscriptionEntitlementsUpdatedEvent:
      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_entitlements_updated_detail:
              $ref: "#/components/schemas/SubscriptionEntitlementsUpdatedDetail"
          required:
          - subscription_entitlements_updated_detail
          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
    SubscriptionGrantConfiguration:
      type: object
      properties:
        subscription_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        unit_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        unit_type:
          type: string
          deprecated: false
          enum:
          - feature
          - custom_pricing_unit
          example: null
        entity_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        entity_type:
          type: string
          deprecated: false
          enum:
          - plan_price
          - addon
          - addon_price
          - charge
          - charge_price
          example: null
        item_price_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        subscription_item_quantity:
          type: integer
          format: int64
          deprecated: false
          example: null
        grant_configuration_version:
          type: integer
          format: int64
          deprecated: false
          example: null
        grant_configuration_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        line_item_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        is_metered:
          type: boolean
          deprecated: false
          example: null
        derivation_type:
          type: string
          deprecated: false
          enum:
          - inherited
          - overridden
          example: null
        grant_configuration_resource_version:
          type: integer
          format: unix-time
          deprecated: false
          example: null
        grant_policies:
          type: array
          deprecated: false
          items:
            type: object
            deprecated: false
            properties:
              id:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              amount:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              trigger_type:
                type: string
                deprecated: false
                enum:
                - interval
                - one_time
                example: null
              trigger_value:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              trigger_period_unit:
                type: string
                deprecated: false
                enum:
                - day
                - month
                - year
                example: null
              rollover_type:
                type: string
                default: none
                deprecated: false
                enum:
                - none
                - unlimited
                - time_limited
                - capped
                example: null
              rollover_cap_value:
                type: string
                deprecated: false
                maxLength: 50
                example: null
              rollover_cap_type:
                type: string
                deprecated: false
                enum:
                - percentage
                - absolute
                example: null
              expiration_type:
                type: string
                default: none
                deprecated: false
                enum:
                - none
                - interval
                example: null
              expiration_value:
                type: string
                deprecated: false
                maxLength: 100
                example: null
              expiration_period_unit:
                type: string
                deprecated: false
                enum:
                - day
                - month
                - year
                example: null
            required:
            - amount
            - expiration_type
            - id
            - rollover_type
            - trigger_type
            example: null
          example: null
      required:
      - derivation_type
      - entity_id
      - grant_configuration_id
      - grant_configuration_resource_version
      - grant_configuration_version
      - is_metered
      - subscription_id
      - subscription_item_quantity
      - unit_id
      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
    SubscriptionMetric:
      type: object
      properties:
        subscription_status:
          type: string
          deprecated: false
          enum:
          - in_trial
          - active
          example: null
        count:
          type: integer
          format: int64
          deprecated: false
          example: null
        last_updated_at:
          type: integer
          format: int64
          deprecated: false
          example: null
        percentage:
          type: number
          format: double
          deprecated: false
          example: null
      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 to 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
    SubscriptionRampAppliedEvent:
      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:
            ramp:
              $ref: "#/components/schemas/Ramp"
          required:
          - ramp
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionRampCreatedEvent:
      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:
            ramp:
              $ref: "#/components/schemas/Ramp"
          required:
          - ramp
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionRampDeletedEvent:
      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:
            ramp:
              $ref: "#/components/schemas/Ramp"
          required:
          - ramp
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionRampDraftedEvent:
      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:
            ramp:
              $ref: "#/components/schemas/Ramp"
          required:
          - ramp
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    SubscriptionRampUpdatedEvent:
      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:
            ramp:
              $ref: "#/components/schemas/Ramp"
          required:
          - ramp
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      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
    SubscriptionSetting:
      type: object
      properties:
        subscription_cancellation:
          type: object
          deprecated: false
          properties:
            effective_from:
              type: string
              deprecated: false
              enum:
              - immediately
              - end_of_term
              - specific_date
              example: null
            credit_option:
              type: string
              deprecated: false
              enum:
              - none
              - prorate
              - full
              - consumption_based
              example: null
            refund_option:
              type: string
              deprecated: false
              enum:
              - no_action
              - schedule_refund
              example: null
            account_receivable_handling:
              type: string
              deprecated: false
              enum:
              - no_action
              - schedule_payment_collection
              - write_off
              example: null
            unbilled_charge_option:
              type: string
              deprecated: false
              enum:
              - invoice
              - delete
              example: null
            apply_credits:
              type: boolean
              default: true
              deprecated: false
              example: null
          example: null
        pause_subscription:
          type: object
          deprecated: false
          properties:
            enabled:
              type: boolean
              deprecated: false
              example: null
            effective_from:
              type: string
              deprecated: false
              enum:
              - immediately
              - end_of_term
              - specific_date
              example: null
            pause_resumption:
              type: string
              deprecated: false
              enum:
              - pause_indefinitely
              - specific_date
              example: null
            unbilled_charges:
              type: string
              deprecated: false
              enum:
              - no_action
              - invoice
              example: null
            invoice_in_dunning:
              type: string
              deprecated: false
              enum:
              - continue
              - stop
              example: null
            resumption:
              type: string
              deprecated: false
              enum:
              - immediately
              - specific_date
              example: null
            invoice_option:
              type: string
              deprecated: false
              enum:
              - invoice_immediately
              - add_to_unbilled_charges
              example: null
            account_receivable:
              type: string
              deprecated: false
              enum:
              - no_action
              - collect_payment
              example: null
          example: null
        gift_subscription:
          type: object
          deprecated: false
          properties:
            enabled:
              type: boolean
              deprecated: false
              example: null
            automatically_claim_gifts:
              type: boolean
              default: false
              deprecated: false
              example: null
            allow_customer_to_claim_gifts_anytime:
              type: boolean
              default: false
              deprecated: false
              example: null
            claim_validity_days:
              type: integer
              format: int32
              deprecated: false
              example: null
          example: null
      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:
      - zero_rated
      - id_exempt
      - customer_exempt
      - region_non_taxable
      - product_exempt
      - export
      - high_value_physical_goods
      - zero_value_item
      - tax_not_configured_external_provider
      example: null
    TaxWithheld:
      type: object
      description: "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 `tax_withheld` resource captures\
        \ the details of such tax deductions.  \n**Note:**\n\n* This resource is available\
        \ as the `linked_taxes_withheld` sub-resource under `invoice`s.\n* Whenever\
        \ refunds are provided against this resource, they are available as `linked_tax_withheld_refunds`\
        \ sub-resource under `credit_note`s.\n"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            An auto-generated unique identifier for the tax withheld. The value starts with the prefix `tax_wh_`.
            For example, `tax_wh_16BdDXSlbu4uV1Ee6`
            .
          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
      - zero_rated
      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\n* direct_debit - Represents\
            \ bank account for which the direct debit or ACH agreement/mandate is\
            \ created.\n* unionpay - Payments made via UnionPay.\n* ovo - Payments\
            \ made via OVO.\n* google_pay - Payments made via Google Pay.\n* mercado_pago\
            \ - Payments made via Mercado Pago.\n* sepa_instant_transfer - Payments\
            \ made via Sepa Instant Transfer\n* dotpay - Payments made via Dotpay.\n\
            * pay_to - Payments made via PayTo\n* klarna - Payments made via Klarna.\n\
            * revolut_pay - Payments made via Revolut Pay.\n* thai_qr - Payments made\
            \ via Thai QR.\n* naver_pay - Payments made via Naver Pay.\n* giropay\
            \ - Payments made via giropay.\n* grab_pay - Payments made via GrabPay\n\
            * rakuten_pay - Payments made via Rakuten Pay.\n* blik - Payments made\
            \ via BLIK.\n* stablecoin - Payments made via Stablecoin.\n* alipay -\n\
            \  Payments made via Alipay.  \n  This payment source is deprecated.\n\
            * kakao_pay - Payments made via Kakao Pay.\n* sofort - Payments made via\
            \ Sofort.\n* gcash - Payments made via GCash.\n* dana - Payments made\
            \ via Dana.\n* pix - Payments made via Pix\n* p24 - Payments made via\
            \ Przelewy24 (P24).\n* pay_co - Payments made via PayCo\n* wechat_pay\
            \ -\n  Payments made via WeChat Pay.  \n  This payment source is deprecated.\n\
            * netbanking_emandates - Netbanking (eMandates) Payments.\n* nupay - Payments\
            \ made via NuPay.\n* picpay - Payments made via PicPay.\n* bancontact\
            \ - Payments made via Bancontact Card.\n* go_pay - Payments made via GoPay\n\
            * nequi - Payments made via Nequi.\n* card - Card based payment including\
            \ credit cards and debit cards. Details about the card can be obtained\
            \ from the card resource.\n* amazon_payments - Payments made via Amazon\
            \ Payments.\n* pay_by_bank - Pay By Bank\n* online_banking_poland - Payments\
            \ made via Online Banking Poland\n* touch_n_go - Payments made via Touch\
            \ 'n Go.\n* after_pay - Payments made via Afterpay\n* faster_payments\
            \ - Payments made via Faster Payments\n* alipay_hk - Payments made via\
            \ Alipay HK.\n* momo - Payments made via MoMo.\n* fpx - Payments made\
            \ via FPX.\n* generic - Payments made via Generic Payment Method.\n* payme\
            \ - Payments made via PayMe\n* tamara - Payments made via Tamara.\n* klarna_pay_now\
            \ - Payments made via Klarna Pay Now\n* twint - Payments made via Twint\n\
            * swish - Payments made via Swish\n* automated_bank_transfer - Represents\
            \ virtual bank account using which the payment will be done.\n* paypal_express_checkout\
            \ - Payments made via PayPal Express Checkout.\n* venmo - Payments made\
            \ via Venmo\n* ideal - Payments made via iDEAL.\n* trustly - Trustly\n\
            * upi - UPI Payments.\n* wero - Payments made via Wero.\n* kbc_payment_button\
            \ - KBC Payment Button\n* cash_app_pay - Payments made via Cash App Pay.\n\
            * payconiq_by_bancontact - Payments made via Payconiq by Bancontact.\n\
            * qpay - Payments made via Qpay.\n* affirm_pay - Payments made via Affirm\
            \ Pay.\n* apple_pay - Payments made via Apple Pay.\n* electronic_payment_standard\
            \ - Electronic 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
          - alipay_hk
          - paypay
          - gcash
          - south_korean_cards
          - paynow
          - bizum
          - promptpay
          - dana
          - touch_n_go
          - tamara
          - qpay
          - ovo
          - momo
          - mercado_pago
          - nequi
          - nupay
          - picpay
          - thai_qr
          - blik
          - fpx
          - wero
          - p24
          - affirm_pay
          - rakuten_pay
          example: null
        gateway:
          type: string
          deprecated: false
          description: "Name of the gateway this card is stored with.\n\n* twikey\
            \ - Twikey is a payment service provider that specializes in processing\
            \ direct debit payments across the EU.\n* bluesnap - BlueSnap is a payment\
            \ gateway.\n* jp_morgan -\n  J.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).\
            \  \n  This 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 - 2Checkout is a payment gateway.\n\
            * deutsche_bank -\n  Deutsche Bank is the leading German bank with strong\
            \ European roots and a global network.  \n  This feature is a **Private\
            \ Beta Release**.\n* bluepay - BluePay is a payment gateway.\n* paypal_express_checkout\
            \ - PayPal Express Checkout is a payment gateway.\n* paypal_payflow_pro\
            \ - PayPal Payflow Pro is a payment gateway.\n* 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.\n* global_payments - Global Payments is a payment service provider.\n\
            * dlocal - Dlocal provides payment solutions for global commerce by accepting\
            \ local payment methods.\n* not_applicable - Indicates that payment gateway\
            \ is not applicable for this resource.\n* checkout_com - Checkout.com\
            \ is a payment gateway.\n* adyen - Adyen is a payment gateway.\n* braintree\
            \ - Braintree is a payment gateway.\n* nmi - NMI is a payment gateway.\n\
            * worldpay - WorldPay is a payment gateway\n* paystack -\n  Paystack is\
            \ a payment gateway for businesses in Africa. It enables secure payment\
            \ acceptance both online and offline.  \n  This 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 - Pay.com\
            \ provides payment services focused on simplicity and hassle-free operations\
            \ for businesses of all sizes.\n* moneris_us - Moneris USA is a payment\
            \ gateway.\n* pin - Pin is a payment gateway\n* authorize_net - Authorize.net\
            \ is a payment gateway\n* stripe - Stripe is a payment gateway.\n* moneris\
            \ - Moneris is a payment gateway.\n* chargebee - Chargebee test gateway.\n\
            * cybersource - CyberSource is a payment gateway.\n* ecentric - Ecentric\
            \ provides a seamless payment processing service in South Africa specializing\
            \ on omnichannel capabilities.\n* first_data_global - First Data Global\
            \ Gateway Virtual Terminal Account\n* exact - Exact Payments is a payment\
            \ gateway.\n* nuvei -\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.  \n  This 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 - eWAY Account\
            \ is a payment gateway.\n* metrics_global - Metrics global is a leading\
            \ payment service provider providing unified payment services in the US.\n\
            * payu - PayU is a payment gateway that enables secure card payment acceptance\
            \ via PaymentsOS.\n* amazon_payments - Amazon Payments is a payment service\
            \ provider.\n* windcave - Windcave provides an end to end payment processing\
            \ solution in ANZ and other leading global markets.\n* quickbooks - Intuit\
            \ QuickBooks Payments gateway\n* wepay - WePay is a payment gateway.\n\
            * ezidebit -\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* wirecard - WireCard\
            \ Account is a payment service provider.\n* chargebee_payments - Chargebee\
            \ Payments gateway\n* sage_pay - Sage Pay is a payment gateway.\n* elavon\
            \ - Elavon Virtual Merchant is a payment solution.\n* paypal_pro - PayPal\
            \ Pro Account is a payment gateway.\n* orbital - Chase Paymentech(Orbital)\
            \ is a payment gateway.\n* paypal - PayPal Commerce is a payment gateway.\n\
            * beanstream - Bambora(formerly known as Beanstream) is a payment gateway.\n\
            * hdfc - HDFC Account is a payment gateway.\n* ingenico_direct - Worldline\
            \ Online Payments is a payment gateway.\n* ogone - Ingenico ePayments\
            \ (formerly known as Ogone) is a payment gateway.\n* migs - MasterCard\
            \ Internet Gateway Service payment gateway.\n* vantiv - Vantiv is a payment\
            \ gateway.\n* bank_of_america - Bank of America Gateway\n* eway_rapid\
            \ - eWAY Rapid is a payment gateway.\n* gocardless - GoCardless is a payment\
            \ service provider.\n* mollie - Mollie is a payment gateway.\n* paymill\
            \ - PAYMILL is a payment gateway.\n* balanced_payments - Balanced is a\
            \ payment gateway\n* solidgate -\n  Solidgate is a secure and reliable\
            \ payment processing solution that allows you to accept payments from\
            \ customers and suitable for various types of businesses.  \n  This feature\
            \ is a **Private Beta Release**.\n* ebanx - EBANX 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
          - payu
          - 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
        network_transaction_reference:
          type: object
          additionalProperties: true
          deprecated: false
          description: |
            The network transaction reference that the vault the card was copied from holds for this card. It is returned only when that vault holds one; otherwise it is omitted. Contains `original_network_transaction_id`, the identifier the card scheme issued for this card.

            Pass that identifier to the destination gateway when you store the card there, to keep the card's stored credential chain intact. This lets the card scheme continue to recognize later merchant-initiated transactions as part of the same series.
          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: |
            A unique display name for the item price in the Chargebee UI. If `external_name`
            is not provided, this is also used in customer-facing pages and documents such as [invoices](/docs/api/invoices)
            and [hosted pages](/docs/api/hosted_pages)
            .
          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: |
            The status of the item price.

            * archived - 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.
            * active - The item price can be used in subscriptions.
            * deleted -
              Indicates that the item price has been deleted. The `id`
              and `name`
              can be reused.
          enum:
          - active
          - archived
          - deleted
          example: null
        external_name:
          type: string
          deprecated: false
          description: |
            The name of the item price used in customer-facing pages and documents. These include [invoices](/docs/api/invoices)
            and [hosted pages](/docs/api/hosted_pages).
            If not provided, then `name`
            is used
          maxLength: 100
          example: null
        price_variant_id:
          type: string
          deprecated: false
          maxLength: 100
          example: null
        proration_type:
          type: string
          deprecated: false
          enum:
          - site_default
          - partial_term
          - full_term
          example: null
        pricing_model:
          type: string
          default: flat_fee
          deprecated: false
          description: |
            The [pricing scheme](https://www.chargebee.com/docs/2.0/plans.html#pricing-models) for this item price. If subscriptions, invoices or [differential prices](/docs/api/differential_prices) exist for this item price, `pricing_model` cannot be changed.

            * 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
        price:
          type: integer
          format: int64
          deprecated: false
          description: |
            The cost of the item price when the pricing model is `flat_fee`.
            When the pricing model is `per_unit`
            , it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in the [minor unit of the currency](/docs/api/getting-started)
            .
          minimum: 0
          example: null
        price_in_decimal:
          type: string
          deprecated: false
          description: |
            The price of the item when the pricing_model is `flat_fee`.
            When the pricing model is `per_unit`
            , 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 [multi-decimal pricing](/docs/api/getting-started)
            is enabled.
          maxLength: 39
          example: null
        period:
          type: integer
          format: int32
          deprecated: false
          description: |
            * When the item `type` is `plan`: The billing period of the plan in `period_unit`s. For example, create a 6 month plan by providing `period` as 6 and `period_unit` as month.
            * When item `type` is `addon`: The period of the addon in `period_unit`s. For example, create an addon with a 2 month `period` by providing period as 2 and `period_unit` as `month`. The period of an addon is the duration for which its `price` applies. When attached to a plan, the addon is billed for the billing period of the plan. [Learn more.](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)

            If subscriptions or invoices exist for this item price, `period`
            cannot be changed. The `period`
            is mandatory when the item `type`
            is `plan`
            or `addon`
          minimum: 1
          example: null
        period_unit:
          type: string
          deprecated: false
          description: |
            The unit of time for `period`.
            If subscriptions or invoices exist for this item price, `period_unit`
            cannot be changed. The `period_unit`
            is mandatory when the item `type`
            is `plan`
            or `addon`

            * month - A period of 1 calendar month.
            * day - A period of 24 hours.
            * week - A period of 7 days.
            * year - A period of 1 calendar year.
          enum:
          - day
          - week
          - month
          - year
          example: null
        trial_period:
          type: integer
          format: int32
          deprecated: false
          description: |
            The trial period of the plan in `trial_period_unit`
            s. You can also set [trial periods for addons](https://www.chargebee.com/docs/2.0/addons-trial.html)
            ; 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 enable that feature.
          minimum: 0
          example: null
        trial_period_unit:
          type: string
          deprecated: false
          description: |
            The unit of time for `trial_period`
            .

            * month - A period of 1 calendar month.
            * day - A period of 24 hours.
          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/2.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)
            has been enabled for the site. Specifies the operation to be carried out for the subscription once the trial ends. Whenever the `item.type`
            is `plan`
            and a trial period is defined for this item price, this attribute (parameter) is returned (required). This can be overridden at the [subscription-level](/docs/api/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/2.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
        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: |
            The default number of billing cycles a subscription to the plan must run. Can be [overridden](/docs/api/subscriptions) for a subscription.
            Addons can also [have billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html). However, you must 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 enable that. Also, for addons, you can [override this](/docs/api/attached_items) while attaching it to a plan. However, if you provide the value while [applying the addon to a subscription](/docs/api/subscriptions/subscription-object#subscription_items_item_type), then that value takes still higher precedence.
            If subscriptions, invoices or [differential prices](/docs/api/differential_prices)
            exist for this item price, `billing_cycles`
            cannot be changed.
          minimum: 1
          example: null
        free_quantity:
          type: integer
          format: int32
          default: 0
          deprecated: false
          description: "Free quantity the subscriptions of this **plan** `item_price`\
            \ will have. Only the quantity exceeding this value will be charged in\
            \ the subscription.  \n**Note:**\n\n* `free_quantity` is currently supported\
            \ only for [plan](/docs/api/items/item-object#type) `item_price`.\n* `free_quantity`\
            \ is not supported for the [Usage-Based Billing](https://www.chargebee.com/docs/2.0/understanding-usages.html)\
            \ (UBB). All included or free quantities should be configured exclusively\
            \ through [entitlements](/docs/api/entitlements) .\n"
          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
          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: |
            If `enabled_for_checkout`
            , then the URL to be redirected to once the checkout is complete. This attribute is only available for plan-items.
          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.
            **Note:**
            Only the in-app layout of Checkout is supported.
          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: |
            The item is included in MRR calculations for your site. This attribute is only applicable for items of `type = charge`
            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 `false`
            .
          example: null
        item_applicability:
          type: string
          default: all
          deprecated: false
          description: |
            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 [Create](/docs/api/attached_items/create-an-attached-item)
            or [Update an attached item](/docs/api/attached_items/update-an-attached-item)
            API.

            * all - all addon-items and charge-items are applicable to this plan-item.
            * restricted -
              only the addon-items or charge-items provided in `applicable_items`
              can be applied to this plan-item.
          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: |
            Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/2.0/finance-integration-index.html )

            * [**Xero:**](https://www.chargebee.com/docs/2.0/xero.html ) If you've categorized your products in Xero, provide the category name and option. Use the format: `:` . For example:`Location: Singapore.`
            * [**QuickBooks:**](https://www.chargebee.com/docs/2.0/quickbooks.html ) If you've categorized your product sales in QuickBooks according to Classes, provide the class name here. Use the following format: `::...`
            * [**NetSuite:**](https://www.chargebee.com/docs/2.0/netsuite.html ) If you've categorized your products in NetSuite under Classes, provide the class name here. Use the following format: `: : ....` For example: `Services : Plan.`
            * [**Intacct:**](https://www.chargebee.com/docs/2.0/intacct.html ) If you've classified your products in Intacct under Locations, provide the name of the Location here.
          maxLength: 100
          example: null
        accounting_category2:
          type: string
          deprecated: false
          description: |
            Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/2.0/finance-integration-index.html )

            * [**Xero:**](https://www.chargebee.com/docs/2.0/xero.html ) If you've categorized your products in Xero, then provide the second category name and option here. Use the format: `: ....` For example, `Region: South`
            * [**QuickBooks:**](https://www.chargebee.com/docs/2.0/quickbooks.html ) If you've categorized your product sales in QuickBooks according to Location, provide the Location name here. Use the following format: `::....` For example: `Location: North America: Canada`
            * [**NetSuite:**](https://www.chargebee.com/docs/2.0/netsuite.html ) If you've categorized your products in NetSuite under Locations, provide the location name here. Use the following format `: : ....` For example: `NA:US:CA`
            * [**Intacct:**](https://www.chargebee.com/docs/2.0/intacct.html ) If you've classified your products in Intacct under Dimensions, provide the value of the Dimension here.
          maxLength: 100
          example: null
        accounting_category3:
          type: string
          deprecated: false
          description: |
            Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/2.0/finance-integration-index.html )

            * [**NetSuite:**](https://www.chargebee.com/docs/2.0/netsuite.html ) If you've categorized your products in NetSuite under Departments, pass the department name here. Use the following format: `: : ....` For example: `Production: Assembly.`
            * [**Intacct:**](https://www.chargebee.com/docs/2.0/intacct.html ) If you've classified your products in Intacct under multiple Dimensions, provide the value of the second Dimension here.
          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 hides 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.
            * bluepay - BluePay is a payment gateway.
            * paypal_express_checkout - PayPal Express Checkout 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.
            * 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.
            * worldpay - WorldPay 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
            * stripe - Stripe is a payment gateway.
            * moneris - Moneris is a payment gateway.
            * chargebee - Chargebee test gateway.
            * cybersource - CyberSource is a payment gateway.
            * first_data_global - First Data Global Gateway Virtual Terminal Account
            * exact - Exact Payments is a payment gateway.
            * eway - eWAY Account is a payment gateway.
            * payu - PayU is a payment gateway that enables secure card payment acceptance via PaymentsOS.
            * amazon_payments - Amazon Payments is a payment service provider.
            * quickbooks - Intuit QuickBooks Payments gateway
            * wepay - WePay 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.
            * 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.
            * vantiv - Vantiv is a payment 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
          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
          - payu
          - 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\n* tamara - Payments\
            \ made via Tamara.\n* alipay_hk - Payments made via Alipay HK.\n* apple_pay\
            \ - Payments made via Apple Pay.\n* bancontact - Payments made via Bancontact\
            \ Card.\n* netbanking_emandates - Netbanking (eMandates) Payments.\n*\
            \ trustly - Trustly\n* after_pay - Payments made via Afterpay\n* giropay\
            \ - Payments made via giropay.\n* fpx - Payments made via FPX.\n* momo\
            \ - Payments made via MoMo.\n* blik - Payments made via BLIK.\n* dana\
            \ - Payments made via Dana.\n* paypal_express_checkout - Payments made\
            \ via PayPal Express Checkout.\n* touch_n_go - Payments made via Touch\
            \ 'n Go.\n* amazon_payments - Payments made via Amazon Payments.\n* electronic_payment_standard\
            \ - Electronic Payment Standard\n* grab_pay - Payments made via GrabPay\n\
            * card - Card based payment including credit cards and debit cards. Details\
            \ about the card can be obtained from the card resource.\n* affirm_pay\
            \ - Payments made via Affirm Pay.\n* p24 - Payments made via Przelewy24\
            \ (P24).\n* thai_qr - Payments made via Thai QR.\n* pay_by_bank - Pay\
            \ By Bank\n* go_pay - Payments made via GoPay\n* generic - Payments made\
            \ via Generic Payment Method.\n* payme - Payments made via PayMe\n* google_pay\
            \ - Payments made via Google Pay.\n* pay_co - Payments made via PayCo\n\
            * ovo - Payments made via OVO.\n* unionpay - Payments made via UnionPay.\n\
            * ideal - Payments made via iDEAL.\n* nequi - Payments made via Nequi.\n\
            * alipay -\n  Payments made via Alipay.  \n  This payment source is deprecated.\n\
            * picpay - Payments made via PicPay.\n* dotpay - Payments made via Dotpay.\n\
            * sofort - Payments made via Sofort.\n* gcash - Payments made via GCash.\n\
            * mercado_pago - Payments made via Mercado Pago.\n* nupay - Payments made\
            \ via NuPay.\n* direct_debit - Represents bank account for which the direct\
            \ debit or ACH agreement/mandate is created.\n* rakuten_pay - Payments\
            \ made via Rakuten Pay.\n* qpay - Payments made via Qpay.\n* upi - UPI\
            \ Payments.\n* wero - Payments made via Wero.\n* swish - Payments made\
            \ via Swish\n* twint - Payments made via Twint\n* wechat_pay -\n  Payments\
            \ made via WeChat Pay.  \n  This payment source is deprecated.\n* kbc_payment_button\
            \ - KBC 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
          - alipay_hk
          - paypay
          - gcash
          - south_korean_cards
          - paynow
          - bizum
          - promptpay
          - dana
          - touch_n_go
          - tamara
          - qpay
          - ovo
          - momo
          - mercado_pago
          - nequi
          - nupay
          - picpay
          - thai_qr
          - blik
          - fpx
          - wero
          - p24
          - affirm_pay
          - rakuten_pay
          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: |
            Version number of this resource. The `resource_version`
            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.
          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: |
            The payment method of this transaction

            * fpx - Payments made via FPX.
            * naver_pay - Payments made via Naver Pay.
            * qpay - Payments made via Qpay.
            * unionpay - Unionpay
            * paypay - PayPay
            * online_banking_poland - Online Banking Poland
            * upi - upi
            * payconiq_by_bancontact - Payments made via Payconiq by Bancontact.
            * kakao_pay - Payments made via Kakao Pay.
            * momo - Payments made via MoMo.
            * check - Check
            * payme - Payments made via PayMe
            * cash_app_pay - Payments made via Cash App Pay.
            * custom - Custom
            * mercado_pago - Payments made via Mercado Pago.
            * amazon_payments - Amazon Payments
            * boleto - boleto
            * klarna - Payments made via Klarna.
            * direct_debit - Direct Debit
            * klarna_pay_now - Klarna Pay Now
            * sepa_instant_transfer - Sepa Instant Transfer
            * p24 - Payments made via Przelewy24 (P24).
            * apple_pay - Apple Pay
            * thai_qr - Payments made via Thai QR.
            * wechat_pay - Payments made via WeChat Pay.
            * twint - Payments made via Twint
            * kbc_payment_button - KBC Payment Button
            * bancontact - Bancontact
            * faster_payments - Faster Payments
            * go_pay - Payments made via GoPay
            * stablecoin - Payments made via Stablecoin.
            * venmo - Venmo
            * wero - Payments made via Wero.
            * touch_n_go - Payments made via Touch 'n Go.
            * bank_transfer - Bank Transfer
            * paypal_express_checkout - Paypal Express Checkout
            * electronic_payment_standard - Electronic Payment Standard
            * other - Payment Methods other than the above types
            * tamara - Payments made via Tamara.
            * trustly - Trustly
            * ach_credit - ACH Credit
            * sepa_credit - SEPA Credit
            * alipay_hk - Payments made via Alipay HK.
            * affirm_pay - Payments made via Affirm Pay.
            * rakuten_pay - Payments made via Rakuten Pay.
            * card - Card
            * gcash - Payments made via GCash.
            * ideal - IDEAL
            * nupay - Payments made via NuPay.
            * chargeback -
              Only applicable for a transaction of [type](/docs/api/transactions/transaction-object#type)
              = `refund`.
              This value is set by Chargebee when an automated [chargeback](https://www.chargebee.com/docs/chargeback.html#chargeback-process)
              occurs. You can also set this explicitly when [recording a refund](/docs/api/transactions/record-an-offline-refund)
              .
            * automated_bank_transfer - Automated Bank Transfer
            * ovo - Payments made via OVO.
            * google_pay - Google Pay
            * dana - Payments made via Dana.
            * nequi - Payments made via Nequi.
            * netbanking_emandates - netbanking_emandates
            * blik - Payments made via BLIK.
            * pay_to - PayTo
            * pay_by_bank - Pay By Bank
            * dotpay - Dotpay
            * alipay - Payments made via Alipay.
            * sofort - Sofort
            * swish - Payments made via Swish
            * grab_pay - Payments made via GrabPay
            * pix - Pix
            * giropay - giropay
            * pay_co - Payments made via PayCo
            * revolut_pay - Payments made via Revolut Pay.
            * cash - Cash
            * after_pay - Payments made via Afterpay
            * south_korean_cards - Payments made via South Korean Cards
            * picpay - Payments made via PicPay.
          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
          - alipay_hk
          - paypay
          - gcash
          - south_korean_cards
          - paynow
          - bizum
          - promptpay
          - dana
          - touch_n_go
          - tamara
          - qpay
          - ovo
          - momo
          - mercado_pago
          - nequi
          - nupay
          - picpay
          - thai_qr
          - blik
          - fpx
          - wero
          - p24
          - affirm_pay
          - rakuten_pay
          example: null
        reference_number:
          type: string
          deprecated: false
          description: |
            The reference number for this transaction. For example, the check number when [payment_method](/docs/api/transactions/transaction-object#payment_method)
            = `check`
            .
          maxLength: 100
          example: null
        gateway:
          type: string
          deprecated: false
          description: "Gateway through which this transaction was done. Applicable\
            \ only for 'Card' Payment Method\n\n* bluesnap - BlueSnap is a payment\
            \ gateway.\n* jp_morgan -\n  J.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).\
            \  \n  This 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 - 2Checkout is a payment gateway.\n\
            * payway - Payway is a payment gateway that enables secure card and payment\
            \ acceptance.\n* 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.\n* dlocal - Dlocal\
            \ provides payment solutions for global commerce by accepting local payment\
            \ methods.\n* checkout_com - Checkout.com is a payment gateway.\n* adyen\
            \ - Adyen is a payment gateway.\n* braintree - Braintree is a payment\
            \ gateway.\n* paystack -\n  Paystack is a payment gateway for businesses\
            \ in Africa. It enables secure payment acceptance both online and offline.\
            \  \n  This 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 - Pay.com\
            \ provides payment services focused on simplicity and hassle-free operations\
            \ for businesses of all sizes.\n* moneris_us - Moneris USA is a payment\
            \ gateway.\n* pin - Pin is a payment gateway\n* moneris - Moneris is a\
            \ payment gateway.\n* chargebee - Chargebee test gateway.\n* cybersource\
            \ - CyberSource is a payment gateway.\n* ecentric - Ecentric provides\
            \ a seamless payment processing service in South Africa specializing on\
            \ omnichannel capabilities.\n* first_data_global - First Data Global Gateway\
            \ Virtual Terminal Account\n* exact - Exact Payments is a payment gateway.\n\
            * nuvei -\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.  \n  This 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 - eWAY Account\
            \ is a payment gateway.\n* payu - PayU is a payment gateway that enables\
            \ secure card payment acceptance via PaymentsOS.\n* amazon_payments -\
            \ Amazon Payments is a payment service provider.\n* sage_pay - Sage Pay\
            \ is a payment gateway.\n* elavon - Elavon Virtual Merchant is a payment\
            \ solution.\n* orbital - Chase Paymentech(Orbital) is a payment gateway.\n\
            * beanstream - Bambora(formerly known as Beanstream) is a payment gateway.\n\
            * hdfc - HDFC Account is a payment gateway.\n* bank_of_america - Bank\
            \ of America Gateway\n* gocardless - GoCardless is a payment service provider.\n\
            * paymill - PAYMILL is a payment gateway.\n* balanced_payments - Balanced\
            \ is a payment gateway\n* twikey - Twikey is a payment service provider\
            \ that specializes in processing direct debit payments across the EU.\n\
            * moyasar - Moyasar is a fully integrated online payment service that\
            \ makes accepting payments simple and secure.\n* deutsche_bank -\n  Deutsche\
            \ Bank is the leading German bank with strong European roots and a global\
            \ network.  \n  This feature is a **Private Beta Release**.\n* bluepay\
            \ - BluePay is a payment gateway.\n* paypal_express_checkout - PayPal\
            \ Express Checkout is a payment gateway.\n* paypal_payflow_pro - PayPal\
            \ Payflow Pro is a payment gateway.\n* global_payments - Global Payments\
            \ is a payment service provider.\n* not_applicable - Indicates that payment\
            \ gateway is not applicable for this resource.\n* nmi - NMI is a payment\
            \ gateway.\n* worldpay - WorldPay is a payment gateway\n* authorize_net\
            \ - Authorize.net is a payment gateway\n* tempus - Tempus Technologies\
            \ is a payment gateway and payments technology provider offering secure\
            \ payment processing with point-to-point encryption (P2PE) and tokenization.\n\
            * stripe - Stripe is a payment gateway.\n* metrics_global - Metrics global\
            \ is a leading payment service provider providing unified payment services\
            \ in the US.\n* windcave - Windcave provides an end to end payment processing\
            \ solution in ANZ and other leading global markets.\n* quickbooks - Intuit\
            \ QuickBooks Payments gateway\n* wepay - WePay is a payment gateway.\n\
            * ezidebit -\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* wirecard - WireCard\
            \ Account is a payment service provider.\n* chargebee_payments - Chargebee\
            \ Payments gateway\n* paypal_pro - PayPal Pro Account is a payment gateway.\n\
            * paypal - PayPal Commerce is a payment gateway.\n* ingenico_direct -\
            \ Worldline Online Payments is a payment gateway.\n* ogone - Ingenico\
            \ ePayments (formerly known as Ogone) is a payment gateway.\n* migs -\
            \ MasterCard Internet Gateway Service payment gateway.\n* vantiv - Vantiv\
            \ is a payment gateway.\n* eway_rapid - eWAY Rapid is a payment gateway.\n\
            * mollie - Mollie is a payment gateway.\n* solidgate -\n  Solidgate is\
            \ a secure and reliable payment processing solution that allows you to\
            \ accept payments from customers and suitable for various types of businesses.\
            \  \n  This feature is a **Private Beta Release**.\n* ebanx - EBANX 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
          - payu
          - not_applicable
          example: null
        type:
          type: string
          deprecated: false
          description: |
            Type of the transaction.

            * authorization -
              The transaction represents an authorization for capturing the [amount](/docs/api/transactions/transaction-object#amount)
              from the customer's [payment_source](/docs/api/payment_sources)
              .
            * payment -
              The transaction represents capture of [amount](/docs/api/transactions/transaction-object#amount)
              from the customer's [payment_source](/docs/api/payment_sources)
              .
            * refund -
              The transaction represents a refund of [amount](/docs/api/transactions/transaction-object#amount)
              to the customer's [payment_source](/docs/api/payment_sources)
              .
            * payment_reversal - Indicates a reversal transaction.
          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: "The status of this transaction.\n\n* in_progress -\n  Transaction\
            \ is being processed by the gateway. This typically happens for [direct\
            \ debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html)\n\
            \  or, in case of cards, refund transactions. Such transactions can take\
            \ 2-7 days to complete, depending on the gateway and payment method.\n\
            * timeout - Transaction failed because of Gateway not accepting the connection.\n\
            * success - The transaction is successful.\n* voided - The transaction\
            \ got voided or authorization expired at gateway.\n* needs_attention -\n\
            \  When connection with the Gateway gets terminated abruptly. For `needs_attention`\n\
            \  status Chargebee automatically reconcile the transaction for few gateways,\
            \ for rest of the gateways you have to use the [Reconcile transaction\
            \ API](/docs/api/transactions/reconcile-transaction).\n  You can use this\
            \ API to update the `id_at_gateway`\n  (Gateway Transaction ID) and `status`\n\
            \  for a [`needs_attention`](/docs/api/transactions/transaction-object#status)\n\
            \  transaction to be reconciled at par with the gateway.  \n  [Learn more](https://www.chargebee.com/docs/payments/2.0/needs-attention-transactions.html)\n\
            \  about `needs_attention`\n  transaction status\n* late_failure - 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.\n* failure - Transaction\
            \ failed. Refer the 'error_code' and 'error_text' fields to know the reason\
            \ for failure\n"
          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](https://www.chargebee.com/docs/payments/2.0/fraud-management/chargebee-fraud-management).

            * 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: |
            Type of authorization transaction.

            * scheduled_capture -
              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 [linked_payments]()
              .
            * verification - The transaction has been created for payment method verification.
            * blocking_funds - The transaction has been created to block the funds from payment method.
          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: |
            Version number of this resource. The `resource_version`
            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.
          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: |
            This is the part of the `amount`
            which has not been invoiced yet and is therefore added to [excess_payments](/docs/api/customers/customer-object#excess_payments)
            for the customer. Applicable only for a transaction of `type`
            = `payment`
            .
          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: |
            This is the `id`
            of the offline transaction that is being refunded or reversed. Applicable only for transaction of `type`
            = `refund`
            or `payment_reversal`
            .
          maxLength: 40
          example: null
        refunded_txn_id:
          type: string
          deprecated: false
          description: |
            This is the `id`
            of the transaction (always of `type`
            = `payment`
            ) being refunded. Applicable only for transaction of `type`
            = `refund`
            .
          maxLength: 40
          example: null
        reference_authorization_id:
          type: string
          deprecated: false
          description: |
            This is the `id`
            of the transaction (always of `type`
            = `authorization`
            ) which authorizes the payment being captured. Applicable only for transaction of `type`
            = `payment`
            .
          maxLength: 40
          example: null
        amount_capturable:
          type: integer
          format: int64
          deprecated: false
          description: |
            This is the part of the authorized `amount`
            that is yet to be captured. The payment capture is recorded as a transaction of of `type`
            = `payment`.
            Applicable only for a transaction of `type`
            = `authorization`
            .
          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 card payment method.
          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 unique ID of the [business entity](/docs/api/getting-started)
            of this `transaction`.
            This is always the same as the business entity of the [customer](/docs/api/transactions/transaction-object#customer_id).
          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: |
                  Current status of this invoice.

                  * pending -
                    The [invoice](/docs/api/invoices/invoice-object#status) is yet to be closed (sent for payment collection). An invoice is generated with this `status` when it has line items that belong to items that are `metered` or when the `subscription.create_pending_invoices`attribute is set to `true`.
                    The [invoice](/docs/api/v2/pcv-1/invoices/invoice-object#status) is yet to be closed (sent for payment collection). All invoices are generated with this `status` when [Metered Billing](https://www.chargebee.com/docs/1.0/metered_billing.html) is enabled for the site.
                  * voided - Indicates a voided invoice.
                  * payment_due - Indicates the payment is not yet collected and is being retried as per retry settings.
                  * 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
                  * not_paid - Indicates the payment is not made and all attempts to collect is failed.
                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: "The status of this transaction.\n\n* needs_attention\
                  \ -\n  When connection with the Gateway gets terminated abruptly.\
                  \ For `needs_attention`\n  status Chargebee automatically reconcile\
                  \ the transaction for few gateways, for rest of the gateways you\
                  \ have to use the [Reconcile transaction API](/docs/api/transactions/reconcile-transaction).\n\
                  \  You can use this API to update the `id_at_gateway`\n  (Gateway\
                  \ Transaction ID) and `status`\n  for a [`needs_attention`](/docs/api/transactions/transaction-object#status)\n\
                  \  transaction to be reconciled at par with the gateway.  \n  [Learn\
                  \ more](https://www.chargebee.com/docs/payments/2.0/needs-attention-transactions.html)\n\
                  \  about `needs_attention`\n  transaction status\n* voided - The\
                  \ transaction got voided or authorization expired at gateway.\n\
                  * late_failure - 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.\n* timeout - Transaction failed because\
                  \ of Gateway not accepting the connection.\n* success - The transaction\
                  \ is successful.\n* failure - Transaction failed. Refer the 'error_code'\
                  \ and 'error_text' fields to know the reason for failure\n* in_progress\
                  \ -\n  Transaction is being processed by the gateway. This typically\
                  \ happens for [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html)\n\
                  \  or, in case of cards, refund transactions. Such transactions\
                  \ can take 2-7 days to complete, depending on the gateway and payment\
                  \ method.\n"
                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: "The status of this transaction.\n\n* needs_attention\
                  \ -\n  When connection with the Gateway gets terminated abruptly.\
                  \ For `needs_attention`\n  status Chargebee automatically reconcile\
                  \ the transaction for few gateways, for rest of the gateways you\
                  \ have to use the [Reconcile transaction API](/docs/api/transactions/reconcile-transaction).\n\
                  \  You can use this API to update the `id_at_gateway`\n  (Gateway\
                  \ Transaction ID) and `status`\n  for a [`needs_attention`](/docs/api/transactions/transaction-object#status)\n\
                  \  transaction to be reconciled at par with the gateway.  \n  [Learn\
                  \ more](https://www.chargebee.com/docs/payments/2.0/needs-attention-transactions.html)\n\
                  \  about `needs_attention`\n  transaction status\n* success - The\
                  \ transaction is successful.\n* voided - The transaction got voided\
                  \ or authorization expired at gateway.\n* in_progress -\n  Transaction\
                  \ is being processed by the gateway. This typically happens for\
                  \ [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html)\n\
                  \  or, in case of cards, refund transactions. Such transactions\
                  \ can take 2-7 days to complete, depending on the gateway and payment\
                  \ method.\n* failure - Transaction failed. Refer the 'error_code'\
                  \ and 'error_text' fields to know the reason for failure\n* late_failure\
                  \ - 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.\n\
                  * timeout - Transaction failed because of Gateway not accepting\
                  \ the connection.\n"
                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 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: |
                An advice code from the payment gateway or network that indicates how to handle a card decline. For example, the value `try_again_later` means you can retry the transaction.
              maxLength: 100
              example: null
          example: null
        network_transaction_details:
          type: object
          deprecated: false
          properties:
            network_transaction_id:
              type: string
              deprecated: false
              maxLength: 100
              example: null
            original_network_transaction_id:
              type: string
              deprecated: false
              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
      - alipay_hk
      - paypay
      - gcash
      - south_korean_cards
      - paynow
      - bizum
      - promptpay
      - dana
      - touch_n_go
      - tamara
      - qpay
      - ovo
      - momo
      - mercado_pago
      - nequi
      - nupay
      - picpay
      - thai_qr
      - blik
      - fpx
      - wero
      - p24
      - affirm_pay
      - rakuten_pay
      - free_trial
      - pay_up_front
      - pay_as_you_go
      - simple
      - compound
      - usage_exceeded
      - spend_exceeded
      - credit_balance_dropped
      - credit
      - debit
      - hold
      - unhold
      example: null
    UnbilledCharge:
      type: object
      description: |
        Unbilled charge represents the charges that are held by passing `invoice_immediately` in various operations such as update subscription, add charge, create subscription, etc. [Learn more.](https://www.chargebee.com/docs/unbilled-charges.html)

        If any invoice is to be created for a subscription all the unbilled charges associated with the subscription will be included in that invoice.

        If any invoice is to be created for a customer, all the unbilled charges associated with its subscriptions will be included in that invoice.

        Any automatic invoice creation like renewal, activation, etc., will include the unbilled charges.

        Subscriptions are invoiced at the start of every term based on the recurring items and charged immediately against the customer's credit card if 'auto_collection' is turned 'on', otherwise the resulting invoice will be created as 'Payment Due'.

        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.
      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.
            * 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.
            * 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.

            * 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_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
          enum:
          - adhoc
          - plan_item_price
          - addon_item_price
          - charge_item_price
          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: |
            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/currencies)
            is enabled.
          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/currencies)
            is enabled.
          maxLength: 33
          example: null
        amount_in_decimal:
          type: string
          deprecated: false
          description: |
            The decimal representation of the amount for the charge, in major units of the currency. Typically equals to `unit_amount_in_decimal`
            x `quantity_in_decimal`.
            Returned when [multi-decimal pricing](/docs/api/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 unique ID of the [business entity](/docs/api/advanced-features)
            of this unbilled charge. This is always the same as the [business entity](/docs/api/unbilled_charges/unbilled_charge-object#customer_id)
            of the customer.
          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: |
                  The price of the tier if the charge model is a `stairtstep`
                  pricing , or the price of each unit in the tier if the charge model is `tiered`
                  /`volume`
                  pricing.
                minimum: 0
                example: null
              starting_unit_in_decimal:
                type: string
                deprecated: false
                description: |
                  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 `ending_unit_in_decimal`
                  of the next lower tier. Returned only when the `line_items.pricing_model`
                  is `tiered`
                  , `volume`
                  or `stairstep`
                  and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 33
                example: null
              ending_unit_in_decimal:
                type: string
                deprecated: false
                description: |
                  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 `starting_unit_in_decimal`
                  of the next higher tier. Returned only when the `line_items.pricing_model`
                  is `tiered`
                  , `volume`
                  or stairstep and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 33
                example: null
              quantity_used_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the quantity purchased from this tier. Returned when the `line_item`
                  is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 33
                example: null
              unit_amount_in_decimal:
                type: string
                deprecated: false
                description: |
                  The decimal representation of the per-unit price for the tier when the `pricing_model`
                  is `tiered`
                  or `volume`.
                  When the `pricing_model`
                  is `stairstep`
                  , it is the decimal representation of the total price for `line_item`.
                  The value is in major units of the currency. Returned when the `line_item`
                  is quantity-based and [multi-decimal pricing](/docs/api/currencies)
                  is enabled.
                maxLength: 40
                example: null
              pricing_type:
                type: string
                deprecated: false
                description: |
                  Pricing type for the tier.

                  * package - Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
                  * flat_fee -
                    Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep**
                    pricing model, `pricing_type`
                    will be set to `flat_fee`
                    by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
                  * per_unit - Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
                enum:
                - per_unit
                - flat_fee
                - package
                example: null
              package_size:
                type: integer
                format: int32
                deprecated: false
                description: |
                  Package size for the tier when pricing type is `package`.
                  Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
                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
    Usage:
      type: object
      description: "**Advanced Usage-Based Billing**\n\nFor high-scale usage ingestion,\
        \ use [Advanced Usage-Based Billing](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/understanding-usages)\
        \ with the [Usage Events API](/docs/api/usage_events). The Usage Events API\
        \ supports schemaless event ingestion at scale, including [individual events](/docs/api/usage_events/create-a-usage-event),\
        \ [batch ingestion](/docs/api/usage_events/ingest-usages-in-batch), and [usage\
        \ file ingestion](/docs/api/usage_files/usage-file-object).\n\nThe Usages\
        \ API is used to record usage for metered item prices in a subscription. This\
        \ API is only applicable when Automated Metered Billing is enabled in Chargebee.\n\
        \nMetered items are those that are billed based on the service usage. Common\
        \ examples include:\n\n* Internet data services.\n* SMS send/receive services.\n\
        * API services that are billed for the number of API calls made, say, per\
        \ month.\n\nAn [item](/docs/api/items) is marked metered by setting its `metered`\
        \ attribute as `true`. Only recurring items can be can be set as `metered`.\
        \ Recurring items are those of `type` `plan` or `addon`. A subscription can\
        \ have both metered and non-metered items. The usages API (described in this\
        \ page), is used to add, retrieve and delete usages for the metered items\
        \ in a subscription.\n\n#### Invoicing Metered Item Prices\n\nWhile non-metered\
        \ items are invoiced in a prepaid manner at the beginning of each billing\
        \ cycle; for metered items, the charges are raised at the end of the billing\
        \ term (postpaid). During the course of the billing period, [usages can be\
        \ added](/docs/api/usages/create-a-usage) as and when they occur. For a given\
        \ `subscription_id` and `item_price_id`, there can be only one usage record\
        \ for a specific `usage_date`. At the end of each term, the invoice is generated\
        \ with `status` as `pending`. Any remaining usage records can continue to\
        \ be added to the subscription until the invoice [closes automatically](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing)\
        \ or is [closed via an API call](/docs/api/invoices/close-a-pending-invoice).\
        \ If a usage record has erroneous information and you want to correct it,\
        \ [delete the usage](/docs/api/usages/delete-a-usage) and add it again.  \n\
        **Max Usages**\n\n* Legacy metered billing applies per-subscription usage\
        \ limits over the subscription lifetime. [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 the limit applicable to your site or to request an increase. For high-volume\
        \ usage at scale, see [Usage-Based Billing](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/understanding-usages).\n\
        * If there are no usages for an item price, the item price is not invoiced.\n"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            A unique and immutable id for the usage. If not provided, it is autogenerated.
          maxLength: 100
          example: null
        usage_date:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            The time at which this usage occurred. Chargebee bills only those usages whose
            `usage_date`
            falls within a time when the subscription `status`
            was `active`
            or `non_renewing`.
            However, the remaining usage records are still stored and are
            [retrievable](/docs/api/usages/retrieve-a-usage).

            **Note:**
            If `usage_date`
            corresponds to a time already invoiced, then it is stored but never invoiced unless the [invoice is regenerated](/docs/api/subscriptions/regenerate-an-invoice)
            .
          example: null
        subscription_id:
          type: string
          deprecated: false
          description: |
            The id of the [subscription](/docs/api/subscriptions)
            to which this usage record belongs.
          maxLength: 100
          example: null
        item_price_id:
          type: string
          deprecated: false
          description: |
            The id of the [item price](/docs/api/item_prices)
            to which this usage belongs. The item price must be a part of the subscription or should have been part of it historically.
          maxLength: 100
          example: null
        invoice_id:
          type: string
          deprecated: false
          description: |
            When the usage has been invoiced, this is the `id`
            of the [invoice](/docs/api/invoices).
            This is cleared when the invoice is `voided`
            or deleted.
          maxLength: 100
          example: null
        line_item_id:
          type: string
          deprecated: false
          description: |
            When the usage has been invoiced, this is the `id`
            of the [invoice.line_item](/docs/api/invoices/invoice-object#line_items)
            that the usage is for. This is cleared when the invoice is [voided](/docs/api/invoices/void-an-invoice)
            or [deleted](/docs/api/invoices/delete-an-invoice)
            .
          maxLength: 100
          example: null
        quantity:
          type: string
          deprecated: false
          description: |
            The quantity specified for this usage record.
          maxLength: 40
          example: null
        source:
          type: string
          deprecated: false
          description: |
            The source from which the usage record was created.

            * admin_console - Operation made through the Chargebee admin UI
            * api - Operation made through the API
            * bulk_operation - Operation that are triggerd through bulk operation.
          enum:
          - admin_console
          - api
          - bulk_operation
          example: null
        note:
          type: string
          deprecated: false
          description: |
            A note for this usage record. This note is not displayed on any customer-facing document or interface such as [invoice PDFs](/docs/api/invoices/retrieve-invoice-as-pdf)
            or [Hosted Pages](/docs/api/hosted_pages)
            .
          maxLength: 500
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            Version number of this resource. The `resource_version`
            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.
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this usage resource was last updated.
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when the item was created.
          example: null
      required:
      - created_at
      - item_price_id
      - quantity
      - subscription_id
      - usage_date
      example: null
    UsageAccumulationResetFrequency:
      type: string
      deprecated: false
      enum:
      - never
      - subscription_billing_frequency
      example: null
    UsageCharge:
      type: object
      description: |
        Usage charge represents the current, unbilled usage for a metered feature in a subscription within its active usage period.
        Each usage charge reflects usage accumulated from the start of the current usage period up to the time of the request.
        It includes:

        * the metered feature (`feature_id`)
        * the included entitlement for the current period (`included_usage`)
        * the total usage recorded so far (`total_usage`)
        * any chargeable usage beyond the included entitlement, including on-demand usage and amount (`on_demand_usage`, `metered_item_price_id`, `amount`)
        * the usage interval (`usage_from`, `usage_to`) used to compute the usage
      properties:
        subscription_id:
          type: string
          deprecated: false
          description: |
            Unique identifier of the subscription to which the usage charge applies.
          maxLength: 100
          example: null
        feature_id:
          type: string
          deprecated: false
          description: |
            Unique identifier of the [feature](/docs/api/features/feature-object#id) for which usage is tracked.
          maxLength: 100
          example: null
        included_usage:
          type: string
          deprecated: false
          description: |
            Usage included in the [subscription entitlement](/docs/api/subscription_entitlements/subscription-entitlement-object) for the current usage period.
          maxLength: 33
          example: null
        total_usage:
          type: string
          deprecated: false
          description: |
            Total usage accumulated so far for the feature in the current usage period.
          maxLength: 33
          example: null
        on_demand_usage:
          type: string
          deprecated: false
          description: |
            Usage beyond the included entitlement for the current usage period. Returned only when the feature has an associated metered addon.
          maxLength: 33
          example: null
        metered_item_price_id:
          type: string
          deprecated: false
          description: |
            Identifier of the metered [item price](/docs/api/item_prices/item-price-object) used to calculate charges. Returned only when the feature has an associated metered addon.
          maxLength: 100
          example: null
        amount:
          type: string
          deprecated: false
          description: |
            Current overage charge computed from usage recorded so far, in major units of the currency. This value can change until the usage period ends. Returned only when the feature has an associated metered addon.
          maxLength: 39
          example: null
        currency_code:
          type: string
          deprecated: false
          description: |
            ISO [currency code](/docs/api/currencies/currency-object#currency_code) in which the overage charges are computed. Returned only when amount exists.
          maxLength: 3
          example: null
        usage_from:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Start timestamp of the usage window used to compute the accumulated [total_usage](/docs/api/usage_charges/usage-charge-object#total_usage) for the feature.
          example: null
        usage_to:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            End timestamp of the usage window used to compute the accumulated [total_usage](/docs/api/usage_charges/usage-charge-object#total_usage) for the feature.
          example: null
      required:
      - feature_id
      - subscription_id
      - usage_from
      - usage_to
      example: null
    UsageEvent:
      type: object
      description: "This resource allows you to record usage events, which are essential\
        \ for usage-based billing. These events track customer consumption and calculate\
        \ charges based on actual usage. You can send usage data to Chargebee using\
        \ two endpoints: [Ingest a Usage Event](/docs/api/usage_events/create-a-usage-event)\
        \ for individual events and [Ingest Usage Events in Batch](/docs/api/usage_events/ingest-usages-in-batch)\
        \ for bulk submissions.\n\nThe usage event resource payload is schema-less,\
        \ providing the flexibility to adapt to your unique business requirements.\
        \ Because usage events are not directly tied to a pricing plan, this resource\
        \ enables independent tracking of feature consumption. Events are processed\
        \ and associated with relevant features as usage data. This information is\
        \ used for billing alongside [entitlements](/docs/api/entitlements), [items](/docs/api/items)(such\
        \ as plans or addons), or [item prices](/docs/api/item_prices) to generate\
        \ invoices. This decoupling of usage data from the product catalog provides\
        \ flexibility in defining and monetizing usage beyond predefined pricing models.\
        \ Additionally, this API supports feature usage analytics, churn prediction,\
        \ and other insights.  \n**Note**\n:- [Learn more](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/usage-based-billing-usecases)\
        \ about the use cases associated with this resource.\n\n* [Learn more](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/understanding-usages)\
        \ about the Usage-based Billing.\n* [Learn more](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/ingesting-usage-from-amazon-s3)\
        \ about ingesting usage events from Amazon S3.  \n**See also**\n\n* [Limits\
        \ for Usage-based Billing in Chargebee](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/understanding-usages#usage-based-billing-limits)\n"
      properties:
        subscription_id:
          type: string
          deprecated: false
          description: |
            The unique identifier of a subscription.
          maxLength: 50
          example: null
        deduplication_id:
          type: string
          deprecated: false
          description: |
            An identifier used by the Chargebee's customer to distinguish between multiple events generated at the same timestamp for a single `subscription_id`.

            The combination of `usage_timestamp`, `subscription_id`, and `deduplication_id` uniquely identifies each event.

            **Example** :
            If 3 events are generated for `subscription_id` = `sub-1` at `2025-04-01T00:00:00.000Z`, each event must have a distinct `deduplication_id`.
          maxLength: 36
          example: null
        usage_timestamp:
          type: integer
          format: int64
          deprecated: false
          description: "The timestamp indicating when this usage occurred, represented\
            \ as [Epoch](https://en.wikipedia.org/wiki/Unix_time)\ntime in **milliseconds**\n\
            .\nExample: `1738732394123`\nrepresents the timestamp for February 5,\
            \ 2025, at 05:13:14.123 UTC.  \n**Note** :\nThe timestamp must be within\
            \ the last **12 hours**\n.\n"
          example: null
        properties:
          type: object
          additionalProperties: true
          deprecated: false
          description: |
            A schema-less field that accepts any JSON-formatted data to define the attributes of the ingested event. It is a requirement to structure the data in a flat format wherever possible for better compatibility with downstream processing.
            We strongly encourage using unique field names-particularly for fields intended for metering purposes. This approach enhances clarity and maintainability in the future.
            For example, a field named `status`,

            * Can represent `string` values such as `accepted` or `processing` in one context.

            * In another scenario, it might hold numeric values, such as HTTP response codes like `200`, `300`, or `400`.

            **Note**:

            * Learn more about [field naming guidelines](/docs/api/usage_files).
          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.\n\nUpload usage events using files {#steps_to_upload_usages_file}\n\
        --------------------------------------------------------------\n\n\nFollow\
        \ these steps to upload usage event files:\n\n**Step 1:** Request an [usage_file](/docs/api/usage_files/usage-file-object)\
        \ object using the upload endpoint. This returns an [url](/docs/api/usage_files/usage_file-object#upload_details).\n\
        \n**Step 2:** Create a CSV file containing the usage event records. Ensure\
        \ that the file meets the expected format and complies with the [file upload\
        \ constraints](/docs/api/usage_files#file_upload_constraints). Only `text/csv`\
        \ files are supported.\n\n**Step 3:** Upload the CSV file using the returned\
        \ [url](/docs/api/usage_files/usage_file-object#upload_details).\n\nMake an\
        \ HTTP `PUT` request to the upload URL. Include the file in the request body\
        \ as binary data (raw file content).\n\n**Step 4:** Check the uploaded [usage_file_status](/docs/api/usage_files/usage_file-object#status)\
        \ using the [retrieve_file_processing_status](/docs/api/usage_files/get-uploaded-file-processing-status)\
        \ endpoint.  \n**Important**\n:\n[Learn more](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/ingesting-usage-from-amazon-s3)\
        \ about ingesting usage events from Amazon S3.\n\n### Best practices {#best_practices}\n\
        \n* We recommend not to create empty files which contain only header rows.\n\
        * We recommend uploading files in batches of **100,000** events per file or\
        \ lesser to ensure optimal performance.\n* We recommend ensuring that no row\
        \ contains extra columns without corresponding headers.\n\n### File upload\
        \ constraints {#file_upload_constraints}\n\n* File names should not contain\
        \ any special characters except for underscores `_` and hyphens `-`.\n* File\
        \ names must be under **150** characters and include the appropriate extensions,\
        \ such as `.csv`.\n* The supported delimiter for CSV file format is **comma(,)**.\n\
        \n**See also**\n\n* [Limits for Usage-based Billing in Chargebee](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/understanding-usages#usage-based-billing-limits)\n\
        \n### File field constraints {#file_field_constraints}\n\n* Make sure your\
        \ file follows the sample file format:\n\n|----------------------|---------------------|---------------------|------------------|-------------------|\n\
        | **deduplication_id** | **subscription_id** | **usage_timestamp** | **input_tokens**\
        \ | **output_tokens** |\n| 123e4567-e89b-12d3   | Sub-01              | 1741156511000\
        \       | 100              | 100               |\n| 987f6543-b21c-34a5   |\
        \ Sub-02              | 1741156511001       | 859              | 194     \
        \          |\n\n* Learn more about [deduplication_id](/docs/api/usage_events/create-a-usage-event#deduplication_id),\
        \ [subscription_id](/docs/api/usage_events/create-a-usage-event#subscription_id),\
        \ and [usage_timestamp](/docs/api/usage_events/create-a-usage-event#usage_timestamp).\n\
        \n* Each row must include [deduplication_id](/docs/api/usage_events/create-a-usage-event#deduplication_id),\
        \ [subscription_id](/docs/api/usage_events/create-a-usage-event#subscription_id),\
        \ and [usage_timestamp](/docs/api/usage_events/create-a-usage-event#usage_timestamp).\
        \ Rows missing any of these fields are flagged as failed events.\n\n* Any\
        \ top-level fields in the event row that are not a recognized field ([deduplication_id](/docs/api/usage_events/create-a-usage-event#deduplication_id),\
        \ [subscription_id](/docs/api/usage_events/create-a-usage-event#subscription_id),\
        \ and [usage_timestamp](/docs/api/usage_events/create-a-usage-event#usage_timestamp))\
        \ will automatically be added to the [properties](/docs/api/usage_events/create-a-usage-event#properties).\n\
        \n  **Field Naming Guidelines**: Ensure that your file's column headers follow\
        \ the required naming rules to avoid processing issues:\n  * **Start with:**\
        \ a lowercase letter (`a-z`)\n* **May include:**\n\n  * Lowercase letters\
        \ (`a-z`)\n  * Numbers (`0-9`)\n  * Underscores (`_`)\n\n|--------------------|----------------------|\n\
        | **Valid Examples** | **Invalid Examples** |\n| `input_tokens`     | `InputTokens`\
        \        |\n| `output_tokens`    | `Output Tokens`      |\n| `feature_usage_1`\
        \  | `123output`          |\n| `output_value`     | `output@value`       |\n\
        | `input_value`      | `input-value`        |\n\n### Validating and handling\
        \ errors {#validating_and_handling_errors}\n\nWhen uploading a usage events\
        \ file using the API, certain validation checks are performed. If issues are\
        \ detected, the upload or processing may fail. The following sections explain\
        \ the possible error scenarios and how they are handled.  \n\n|       Error\
        \ Code        |                                                          \
        \                                                                        \
        \                                                                        \
        \                              Description                               \
        \                                                                        \
        \                                                                        \
        \                                                         |\n|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n\
        | `INVALID_FILE`          | This error occurs in the following scenarios:\
        \ * The file is not in a supported [MIME type](/docs/api/usage_files/get-usages-file-upload-url#mime_type),\
        \ so the upload [URL](/docs/api/usage_files/usage_file-object#upload_details)\
        \ is not generated. * The file contains invalid or corrupt content that prevents\
        \ successful parsing. **Error Message:** \"The file format, size, or content\
        \ is invalid. Please ensure the file is in the correct format and adheres\
        \ to the size limits.\" |\n| `DUPLICATE_COLUMNS`     | This error occurs when\
        \ the file contains duplicate column headers, which must be unique. **Error\
        \ Message:** \"Duplicate columns found: \\[list of duplicates\\]. Please remove\
        \ duplicates from your file before uploading again.\"                    \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                |\n| `RECORD_LIMIT_EXCEEDED` | This error occurs when the\
        \ number of records in the uploaded file exceeds the system-defined limit.\
        \ The `[limit]` placeholder specifies the maximum allowed records. **Error\
        \ Message:** \"The number of records exceeds the allowed limit of \\[limit\\\
        ]. Please reduce the number of records in the file and try uploading again.\"\
        \                                                                        \
        \                                                                        \
        \          |\n| `PARTIAL_FAILURE`       | This error indicates that some records\
        \ in the file failed to process, while others were processed successfully.\
        \ Review the failed records in the UI or failed queue for more details. **Error\
        \ Message:** \"Some records in the file could not be processed successfully.\
        \ Please check the failed records in the \\[UI/Failed Queue\\] for more details.\"\
        \                                                                        \
        \                                                             |\n| `COMPLETE_FAILURE`\
        \      | This error indicates that all records in the uploaded file failed\
        \ to process. Review the file, fix the issues, and try uploading it again.\
        \ **Error Message:** \"All records in the file failed to process. Please check\
        \ the failed records in the \\[UI/Failed Queue\\] for more details.\"    \
        \                                                                        \
        \                                                                        \
        \                                               |\n| `INVALID_COLUMNS`   \
        \    | This error indicates that the file contains invalid column headers.\
        \ **Error Message:** \"Invalid columns found: \\[list of invalid headers\\\
        ]. Please correct column names in your file before uploading again.\"    \
        \                                                                        \
        \                                                                        \
        \                                                                        \
        \                                                 |\n\n**Note** :\nUsage events\
        \ flagged as failed appear in the **Usages** \\> [**Failed Events**](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/ingesting-usage-events-into-chargebee#failed_events)\n\
        section of the **Admin UI Dashboard**.\n"
      properties:
        id:
          type: string
          deprecated: false
          description: |
            A unique identifier for the usage file.
          maxLength: 36
          example: null
        name:
          type: string
          deprecated: false
          description: |
            The name of the uploaded file.
          maxLength: 150
          example: null
        mime_type:
          type: string
          deprecated: false
          description: "Indicates the format of a file.  \n**Note:**\nCurrently, only\
            \ `text/csv`\nis supported.\n"
          maxLength: 100
          example: null
        error_code:
          type: string
          deprecated: false
          description: |
            A short, machine-readable code that indicates the reason for the failure. [Learn more](/docs/api/usage_files)
            about the error codes.
          maxLength: 50
          example: null
        error_reason:
          type: string
          deprecated: false
          description: |
            A descriptive, human-readable message explaining the failure. [Learn more](/docs/api/usage_files)
            about the error messages.
          maxLength: 500
          example: null
        status:
          type: string
          default: queued
          deprecated: false
          description: |
            Current status of the usage file.

            * processed - The file processing is completed.
            * failed - The file failed to process.
            * imported - The file has been imported.
            * processing - The file is currently being processed.
            * queued - The file is queued for upload.
          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: |
            Pre-signed URL for the `error_file`
            containing [error_codes](/docs/api/usage_files/usage_file-object#error_code).
            The link is valid for 60 minutes.
          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 that allows you to upload usage events file.
              maxLength: 2000
              example: null
            expires_at:
              type: integer
              format: unix-time
              deprecated: false
              description: |
                Expiry time of the pre-signed 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
    UsageReminderInfo:
      type: object
      description: ""
      properties:
        usage_date_start:
          type: integer
          format: unix-time
          deprecated: false
          description: ""
          example: null
        usage_date_end:
          type: integer
          format: unix-time
          deprecated: false
          description: ""
          example: null
      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: |
            The total usage aggregated over the reporting window defined by `aggregated_from` and `aggregated_to`. 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.
          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
    ValueSchema:
      type: object
      properties: {}
      example: null
    Variant:
      type: object
      description: |
        A product variant is a specific product version with a unique combination of product option values.
      properties:
        id:
          type: string
          deprecated: false
          description: |
            The immutable unique identifier of a product variant.
          maxLength: 100
          example: null
        name:
          type: string
          deprecated: false
          description: |
            This is a unique name that appears for each product variant to the end user.
          maxLength: 100
          example: null
        external_name:
          type: string
          deprecated: false
          description: |
            This is a unique name appears for each product variant to the end user.
          maxLength: 100
          example: null
        description:
          type: string
          deprecated: false
          description: |
            Description of the product variant.
          maxLength: 500
          example: null
        sku:
          type: string
          deprecated: false
          description: |
            A unique identifier code a seller assigns to each product variant. Retailers and merchants use SKUs to keep track of inventory and sales data and help organize products within a store or warehouse. SKUs can include a combination of letters, numbers, and symbols and can vary in length depending on the seller's needs.
          maxLength: 100
          example: null
        deleted:
          type: boolean
          default: false
          deprecated: false
          description: |
            Product variant is deleted or not. If the value is `true`
            then the product variant has been deleted else it exists. Once the product variant is deleted, you can reuse the product variant `id`
            and `name`
            .
          example: null
        product_id:
          type: string
          deprecated: false
          description: |
            The unique identifier of the product that is associated with this variant.
          maxLength: 100
          example: null
        status:
          type: string
          deprecated: false
          description: |
            Status of the product variant.

            * active - The active product variants are visible on the storefront, subscription, or checkout.
            * inactive - The inactive product variants are not visible on the storefront, subscription, or checkout.
          enum:
          - active
          - inactive
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp when the product variant was created.
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          description: |
            Version number of this resource. The `resource_version`
            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.
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          description: |
            Timestamp indicating when this product variant was last updated.
          example: null
        metadata:
          type: object
          additionalProperties: true
          deprecated: false
          description: "A collection of key-value pairs that provides extra information\
            \ about the variant.  \n**Note:**\nThere's a character limit of 65,535.\n\
            \n[Learn more](/docs/api/advanced-features#metadata)\n.\n"
          example: null
        option_values:
          type: array
          deprecated: false
          description: |
            List of product variants option values.
          items:
            type: object
            deprecated: false
            properties:
              name:
                type: string
                deprecated: false
                description: |
                  Name of the option values.
                maxLength: 100
                example: null
              value:
                type: string
                deprecated: false
                description: |
                  Pass values of the `option_values`
                  .
                maxLength: 100
                example: null
            example: null
          example: null
      required:
      - created_at
      - deleted
      - name
      - product_id
      example: null
    VariantCreatedEvent:
      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:
            variant:
              $ref: "#/components/schemas/Variant"
          required:
          - variant
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    VariantCriteria:
      type: object
      properties: {}
      example: null
    VariantDeletedEvent:
      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:
            variant:
              $ref: "#/components/schemas/Variant"
          required:
          - variant
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    VariantUpdatedEvent:
      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:
            variant:
              $ref: "#/components/schemas/Variant"
          required:
          - variant
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    VaultTokenCreatedEvent:
      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:
            vaulted_payment_method:
              $ref: "#/components/schemas/VaultedPaymentMethod"
          required:
          - vaulted_payment_method
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    VaultTokenDeletedEvent:
      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:
            vaulted_payment_method:
              $ref: "#/components/schemas/VaultedPaymentMethod"
          required:
          - vaulted_payment_method
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    VaultTokenUpdatedEvent:
      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:
            vaulted_payment_method:
              $ref: "#/components/schemas/VaultedPaymentMethod"
          required:
          - vaulted_payment_method
          example: null
      required:
      - api_version
      - content
      - event_type
      - id
      - object
      - occurred_at
      - source
      - webhook_status
      example: null
    VaultedPaymentMethod:
      type: object
      properties:
        id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        customer_id:
          type: string
          deprecated: false
          maxLength: 50
          example: null
        credit_card_id:
          type: string
          deprecated: false
          maxLength: 40
          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
      - credit_card_id
      - customer_id
      - id
      - modified_at
      example: null
    VirtualBankAccount:
      type: object
      description: |
        A virtual bank account gives customers a dedicated account to pay into, so you don't share your organization's sensitive bank account details with them. You can create a virtual bank account for a customer and share the payment instructions. Customers pay using methods such as ACH credit or wire transfer. Chargebee automatically applies incoming funds to the customer's due invoices.
      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: "Type of the credit transfer\n\n* eu_automated_bank_transfer\
            \ - EU Automated Bank Transfer\n* ach_credit -\n  ACH Credit Transfer\
            \  \n  This scheme is deprecated. Instead of `ach_credit`\n  use `us_automated_bank_transfer`\n\
            \  .\n* gb_automated_bank_transfer - UK Automated Bank Transfer\n* mx_automated_bank_transfer\
            \ - MX Automated Bank Transfer\n* jp_automated_bank_transfer - JP Automated\
            \ Bank Transfer\n* us_automated_bank_transfer - US Automated Bank Transfer\n\
            * sepa_credit -\n  SEPA Credit Transfer  \n  This scheme is deprecated.\
            \ Instead of `sepa_credit`\n  use `eu_automated_bank_transfer`\n  .\n"
          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\
            \n* twikey - Twikey is a payment service provider that specializes in\
            \ processing direct debit payments across the EU.\n* ecentric - Ecentric\
            \ provides a seamless payment processing service in South Africa specializing\
            \ on omnichannel capabilities.\n* bluesnap - BlueSnap is a payment gateway.\n\
            * jp_morgan -\n  J.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).\
            \  \n  This 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 - 2Checkout is a payment gateway.\n\
            * first_data_global - First Data Global Gateway Virtual Terminal Account\n\
            * payway - Payway is a payment gateway that enables secure card and payment\
            \ acceptance.\n* moyasar - Moyasar is a fully integrated online payment\
            \ service that makes accepting payments simple and secure.\n* exact -\
            \ Exact Payments is a payment gateway.\n* deutsche_bank -\n  Deutsche\
            \ Bank is the leading German bank with strong European roots and a global\
            \ network.  \n  This feature is a **Private Beta Release**.\n* bluepay\
            \ - BluePay is a payment gateway.\n* paypal_express_checkout - PayPal\
            \ Express Checkout is a payment gateway.\n* nuvei -\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.  \n  This\
            \ 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 - eWAY Account\
            \ is a payment gateway.\n* metrics_global - Metrics global is a leading\
            \ payment service provider providing unified payment services in the US.\n\
            * payu - PayU is a payment gateway that enables secure card payment acceptance\
            \ via PaymentsOS.\n* paypal_payflow_pro - PayPal Payflow Pro is a payment\
            \ gateway.\n* 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.\n* global_payments -\
            \ Global Payments is a payment service provider.\n* amazon_payments -\
            \ Amazon Payments is a payment service provider.\n* dlocal - Dlocal provides\
            \ payment solutions for global commerce by accepting local payment methods.\n\
            * not_applicable - Indicates that payment gateway is not applicable for\
            \ this resource.\n* windcave - Windcave provides an end to end payment\
            \ processing solution in ANZ and other leading global markets.\n* checkout_com\
            \ - Checkout.com is a payment gateway.\n* adyen - Adyen is a payment gateway.\n\
            * braintree - Braintree is a payment gateway.\n* nmi - NMI is a payment\
            \ gateway.\n* quickbooks - Intuit QuickBooks Payments gateway\n* wepay\
            \ - WePay is a payment gateway.\n* worldpay - WorldPay is a payment gateway\n\
            * paystack -\n  Paystack is a payment gateway for businesses in Africa.\
            \ It enables secure payment acceptance both online and offline.  \n  This\
            \ 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  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 - Pay.com provides payment\
            \ services focused on simplicity and hassle-free operations for businesses\
            \ of all sizes.\n* wirecard - WireCard Account is a payment service provider.\n\
            * chargebee_payments - Chargebee Payments gateway\n* sage_pay - Sage Pay\
            \ is a payment gateway.\n* moneris_us - Moneris USA is a payment gateway.\n\
            * pin - Pin is a payment gateway\n* authorize_net - Authorize.net is a\
            \ payment gateway\n* elavon - Elavon Virtual Merchant is a payment solution.\n\
            * paypal_pro - PayPal Pro Account is a payment gateway.\n* orbital - Chase\
            \ Paymentech(Orbital) is a payment gateway.\n* paypal - PayPal Commerce\
            \ is a payment gateway.\n* beanstream - Bambora(formerly known as Beanstream)\
            \ is a payment gateway.\n* hdfc - HDFC Account is a payment gateway.\n\
            * ingenico_direct - Worldline Online Payments is a payment gateway.\n\
            * ogone - Ingenico ePayments (formerly known as Ogone) is a payment gateway.\n\
            * migs - MasterCard Internet Gateway Service payment gateway.\n* tempus\
            \ - Tempus Technologies is a payment gateway and payments technology provider\
            \ offering secure payment processing with point-to-point encryption (P2PE)\
            \ and tokenization.\n* stripe - Stripe is a payment gateway.\n* vantiv\
            \ - Vantiv is a payment gateway.\n* moneris - Moneris is a payment gateway.\n\
            * bank_of_america - Bank of America Gateway\n* chargebee - Chargebee test\
            \ gateway.\n* eway_rapid - eWAY Rapid is a payment gateway.\n* gocardless\
            \ - GoCardless is a payment service provider.\n* mollie - Mollie is a\
            \ payment gateway.\n* paymill - PAYMILL is a payment gateway.\n* balanced_payments\
            \ - Balanced is a payment gateway\n* solidgate -\n  Solidgate is a secure\
            \ and reliable payment processing solution that allows you to accept payments\
            \ from customers and suitable for various types of businesses.  \n  This\
            \ feature is a **Private Beta Release**.\n* cybersource - CyberSource\
            \ is a payment gateway.\n* ebanx - EBANX 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
          - payu
          - 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: |
            Version number of this resource. The `resource_version`
            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.
          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: |
            Indicates whether the webhook endpoint is disabled. If `true`
            , the endpoint is disabled; if `false`
            , it is enabled.
          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: "Indicates the response schema used in the webhook payload,\
            \ based on the product catalog version configured for the site.  \n**Note**\n\
            This field is only applicable if the site is in [`compat`](https://www.chargebee.com/docs/billing/1.0/product-catalog/product-catalog-coexistence-ui-changes)\
            \ mode.\n\n* compat - 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.\n* plans_addons -\n  The webhook payload\
            \ follows the [Product Catalog 1.0](https://www.chargebee.com/docs/billing/1.0/product-catalog/product-catalog)\n\
            \  schema and uses the [Plans](/docs/api/v2/pcv-1/plans)\n  and [Addons](/docs/api/v2/pcv-1/addons)\n\
            \  model.\n* items -\n  The webhook payload follows the [Product Catalog\
            \ 2.0](https://www.chargebee.com/docs/billing/2.0/product-catalog/product-catalog)\n\
            \  schema and uses the [Items API model](/docs/api/items)\n  .\n"
          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/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/webhook_endpoints)
              .

              * entitlement_overrides_auto_removed - Triggered when subscription entitlement overrides for a feature are automatically removed after expiry.
              * omnichannel_subscription_item_mrr_updated - Triggered when an omnichannel subscription item's MRR is updated.
              * payment_source_expired - Sent when a payment source for a customer expires.
              * business_ruleset_updated - Triggered when a [business ruleset](/docs/api/business_rulesets) is [updated](/docs/api/business_rulesets/update-a-business-ruleset).
              * payment_succeeded - Sent when the payment is successfully collected.
              * order_ready_to_process - Triggered when an order reaches its order date.
              * price_variant_updated - Triggered when a price variant is updated.
              * subscription_scheduled_changes_removed - Sent when a scheduled change for the subscription is removed.
              * payment_failed - Sent when an attempt to charge the customer's credit card fails.
              * coupon_codes_deleted - Sent when coupon codes are deleted from a coupon set.
              * customer_changed - Sent when a customer is changed.
              * subscription_scheduled_resumption_removed - Triggered when a scheduled resumption is removed for the subscription.
              * differential_price_deleted - Triggered when a differential price is deleted.
              * card_expired - Sent when a card for a customer expires.
              * omnichannel_one_time_order_created - Triggered when an omnichannel one-time order is created.
              * subscription_canceled_with_backdating - Sent when the subscription is cancelled, with the cancellation backdated. If it is cancelled due to non-payment or a missing card, the reason is available in `cancel_reason`.
              * attached_item_deleted - Triggered when an attached item is deleted.
              * hierarchy_created - Triggered when a hierarchy is created.
              * order_cancelled - Triggered when an order is cancelled.
              * business_ruleset_activated - Triggered when a [business ruleset](/docs/api/business_rulesets) is [activated](/docs/api/business_rulesets/activate-a-business-ruleset), so Chargebee starts evaluating the rules it contains.
              * payment_due_reminder - Sent after scheduled days of payment failure
              * authorization_succeeded - Triggered when an authorization transaction is created.
              * order_deleted - Triggered when an order is deleted.
              * payment_initiated - Sent when a payment is initiated via direct debit.
              * order_resent - Triggered when an order is resent.
              * coupon_updated - Sent when a coupon is changed.
              * grant_blocks_updated -
              * item_price_updated - Triggered when an item price is updated.
              * coupon_set_created - Sent when a coupon set is created.
              * subscription_cancelled - Sent when the subscription is cancelled. If it is cancelled due to non-payment or a missing card, the reason is available in `cancel_reason`.
              * subscription_paused - Sent when the subscription is paused.
              * transaction_updated - Triggered when a transaction is updated. For example, when a transaction is removed, when an excess payment is applied to an invoice, or when `amount_capturable` is updated.
              * omnichannel_subscription_created - Triggered when an omnichannel subscription is created.
              * order_created - Triggered when an order is created.
              * invoice_updated - Triggered when changes are made to a finalized invoice, including voiding, deletion, invoice address updates, status changes, and payment changes such as applying or removing a payment, applying or removing a credit, and credit note creation. `pending_invoice_updated` is triggered for changes specific to pending invoices; invoice_updated covers all other invoice changes.
              * unbilled_charges_deleted - Triggered when unbilled charges are deleted.
              * business_entity_updated - Sent when a business entity is updated.
              * feature_deleted - Triggered when a feature is deleted.
              * omnichannel_subscription_item_dunning_started - Triggered when an omnichannel subscription item's dunning has started.
              * payment_source_business_entity_changed -
              * feature_archived - Triggered when a feature is archived.
              * attached_item_created - Triggered when an attached item is created.
              * card_updated - Sent when the card is updated for a customer.
              * gift_unclaimed - Triggered when a new gift is unclaimed and is ready to be claimed.
              * subscription_trial_end_reminder - Sent when the customer's trial period is about to end.
              * hierarchy_deleted - Triggered when a hierarchy is deleted.
              * subscription_changed - Sent after the subscription's recurring items have been changed.
              * gift_scheduled - Triggered when a new gift is created.
              * differential_price_created - Triggered when a differential price is created.
              * invoice_generated_with_backdating - Event triggered when a new invoice is generated with a past date as the invoice date.
              * payment_intent_updated - Sent when a payment intent is updated.
              * pending_invoice_updated - Triggered when you make the following changes to a pending invoice: add a charge, add a non-recurring addon, or delete a line item.
              * promotional_credits_deducted - Sent when promotional credits are deducted for a customer.
              * subscription_ramp_created - Triggered when a subscription ramp is created.
              * omnichannel_subscription_item_cancellation_scheduled - Triggered when an omnichannel subscription item is scheduled for cancellation.
              * subscription_started - Sent when a `future` subscription starts on the scheduled date.
              * credit_note_deleted - Sent when a credit note is deleted.
              * credit_note_updated - Sent when a credit note is updated.
              * item_family_created - Triggered when an item family is created.
              * contract_term_terminated - Triggered when a contract term is terminated.
              * contract_term_cancelled - Triggered when a contract term is cancelled.
              * sales_order_created - Triggered when a sales order is created.
              * subscription_cancellation_reminder - Sent when the customer's subscription is nearing its scheduled cancellation date.
              * item_family_deleted - Triggered when an item family is deleted.
              * order_returned - Triggered when an order is marked as returned.
              * item_price_created - Triggered when an item price is created.
              * business_entity_created - Sent when a business entity is created.
              * omnichannel_subscription_item_resumed - Triggered when an omnichannel subscription item is resumed.
              * subscription_renewal_reminder - Sent before each subscription renewal, based on the plan's period.
              * item_family_updated - Triggered when an item family is updated.
              * promotional_credits_added - Sent when promotional credits are added for a customer.
              * business_entity_deleted - Sent when a business entity is deleted.
              * business_rule_activated - Triggered when a [business rule](/docs/api/business_rules) is [activated](/docs/api/business_rules/activate-a-business-rule), so Chargebee starts evaluating its released version.
              * virtual_bank_account_deleted - Sent when a virtual bank account is deleted for a customer.
              * payment_schedules_updated - Event triggered when payment schedules are updated for an invoice.
              * dunning_updated - Sent when dunning is paused for an invoice.
              * payment_source_added - Sent when a payment source is added for a customer.
              * customer_entitlements_updated - Triggered when entitlements for a list of customers are updated.
              * subscription_moved_in - Triggered when a subscription is moved from another customer.
              * item_created - Triggered when an item is created.
              * record_purchase_failed - Triggered when an omnichannel record purchase fails.
              * subscription_changes_scheduled - Sent when subscription changes are scheduled for later. The changes are applied at the end of the current term.
              * feature_created - Triggered when a feature is created.
              * coupon_set_deleted - Sent when a coupon set is deleted.
              * item_deleted - Triggered when an item is deleted.
              * coupon_set_updated - Sent when a coupon set is changed.
              * subscription_items_renewed - Sent when one or more subscription items are renewed.
              * subscription_scheduled_cancellation_removed - Sent when a scheduled cancellation is removed for the subscription.
              * business_ruleset_deactivated - Triggered when a [business ruleset](/docs/api/business_rulesets) is [deactivated](/docs/api/business_rulesets/deactivate-a-business-ruleset), so Chargebee stops evaluating it.
              * coupon_created - Sent when a coupon is created.
              * omnichannel_subscription_item_upgraded - Triggered when an omnichannel subscription item is upgraded.
              * order_updated - Triggered when an order is updated.
              * item_price_deleted - Triggered when an item price is deleted.
              * purchase_created - Triggered when a purchase action is completed successfully.
              * gift_cancelled - Triggered when a gift is cancelled.
              * subscription_renewed - Sent when the subscription is renewed from the current term.
              * omnichannel_subscription_item_cancelled - Triggered when an omnichannel subscription item is cancelled.
              * subscription_scheduled_pause_removed - Triggered when a scheduled pause is removed for the subscription.
              * grant_blocks_created -
              * quote_updated - Triggered when a quote is updated.
              * customer_created - Sent when a customer is created. This event occurs when a new customer is created on its own, or when a customer is created automatically during subscription creation.
              * tax_withheld_refunded - Sent when a tax withheld refund is made.
              * alert_status_changed -
                Triggered when an alert's runtime status for a subscription changes between IN_ALARM and WITHIN_LIMIT.
                This indicates a change in the subscription's usage relative to the alert threshold and applies only to usage-based billing.
              * coupon_deleted - Sent when a coupon is deleted.
              * order_delivered - Triggered when an order is marked as delivered.
              * differential_price_updated - Triggered when a differential price is updated.
              * subscription_pause_scheduled - Sent when the subscription is scheduled to pause.
              * omnichannel_transaction_created - Triggered when an omnichannel transaction is created.
              * usage_file_ingested - Triggered when a usage file is ingested.
              * subscription_entitlements_updated - Triggered when subscription entitlements are updated because of a subscription change event.
              * voucher_created - Triggered when a payment voucher is created.
              * entitlement_overrides_removed - Triggered when an override entitlement is removed.
              * subscription_business_entity_changed - Sent when a subscription's business entity is changed.
              * subscription_ramp_drafted - Triggered when a subscription ramp is moved to draft status.
              * add_usages_reminder - Sent every month day before renewal date of plan's period
              * contract_term_created - Triggered when a new contract term is created.
              * subscription_resumed - Sent when the subscription is moved from the paused state to the active state.
              * virtual_bank_account_updated - Sent when the virtual bank account is updated for a customer.
              * order_ready_to_ship - Triggered when an order reaches its shipping date.
              * omnichannel_subscription_imported - Triggered when an omnichannel subscription item is imported.
              * payment_source_expiring - Sent when the customer's payment source is expiring soon. Sent 30 days before the expiry date.
              * business_ruleset_deleted -
              * ledger_updated -
              * omnichannel_subscription_item_grace_period_started - Triggered when an omnichannel subscription item's grace period has started.
              * subscription_advance_invoice_schedule_removed - Triggered when a scheduled advance invoice is removed for a subscription.
              * subscription_entitlements_created - Triggered when subscription entitlements are created for a new subscription.
              * card_added - Sent when a card is added for a customer.
              * customer_moved_out - Sent when a customer is copied to another site.
              * gift_updated - Triggered when a gift is updated.
              * payment_schedule_scheme_deleted - Event triggered when a payment schedule scheme is deleted.
              * 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.
              * customer_deleted - Sent when a customer is deleted.
              * price_variant_created - Triggered when a price variant is created.
              * business_ruleset_created - Triggered when a [business ruleset](/docs/api/business_rulesets) is [created](/docs/api/business_rulesets/create-a-business-ruleset). The ruleset is created with `active` set to `false`, so it is not evaluated until it is activated.
              * customer_moved_in - Sent when a customer is copied from another site.
              * payment_schedule_scheme_created - Event triggered when a new payment schedule scheme is created.
              * contract_term_renewed - Triggered when a contract term is renewed.
              * item_entitlements_removed - Triggered when item entitlements are removed for a feature.
              * item_price_entitlements_updated - Triggered when item price entitlements are updated for a feature.
              * price_variant_deleted - Triggered when a price variant is deleted.
              * token_created - Sent when a token is created.
              * voucher_expired - Triggered when a payment voucher expires.
              * omnichannel_subscription_item_expired - Triggered when an omnichannel subscription item expires.
              * item_updated - Triggered when an item is updated.
              * feature_activated - Triggered when a feature `status` transitions to `active` for the first time.
              * business_rule_deleted - Triggered when a [business rule](/docs/api/business_rules) is [deleted](/docs/api/business_rules/delete-a-business-rule) and removed from every ruleset it belonged to.
              * unbilled_charges_invoiced - Triggered when unbilled charges are invoiced.
              * omnichannel_subscription_item_renewed - Triggered when an omnichannel subscription item is renewed.
              * gift_claimed - Triggered when a gift is claimed.
              * omnichannel_one_time_order_item_cancelled - Triggered when an omnichannel one-time order item is cancelled.
              * unbilled_charges_voided - Triggered when unbilled charges are voided.
              * omnichannel_subscription_item_scheduled_change_removed - Triggered when a scheduled change for an omnichannel subscription item is removed.
              * subscription_created_with_backdating - Sent when a new subscription is created with backdating.
              * subscription_reactivated - Sent when the subscription is moved from the cancelled state to the active or in_trial state.
              * ledger_account_balance_updated -
              * payment_source_locally_deleted - Sent when a payment source for a customer is removed from Chargebee.
              * authorization_voided - Triggered when an authorization transaction is voided. An authorization can be voided either manually or when blocked funds are released by the gateway after a certain period of time.
              * einvoice_created - Triggered when an e-invoice is created for an invoice or credit note.
              * token_expired - Sent when a token expires.
              * omnichannel_subscription_item_reactivated - Triggered when an omnichannel subscription item is reactivated.
              * omnichannel_subscription_item_updated - Triggered when an omnichannel subscription item is updated.
              * subscription_activated_with_backdating - Sent after the subscription changes to `active` from another `status`, while the change is backdated.
              * invoice_deleted - Event triggered when an invoice is deleted.
              * quote_deleted - Triggered when a quote is deleted.
              * subscription_reactivated_with_backdating - Sent when the subscription is moved from the cancelled state to the active or in_trial state, with a past date.
              * subscription_moved_out - Triggered when a subscription is moved to another customer.
              * subscription_shipping_address_updated - Triggered when a shipping address is added or updated for a subscription.
              * token_consumed - Sent when a token is consumed.
              * transaction_deleted - Triggered when a transaction is deleted.
              * subscription_ramp_deleted - Triggered when a subscription ramp is deleted.
              * subscription_trial_extended - Sent when the trial period of a subscription is extended.
              * coupon_codes_updated - Sent when coupon codes are updated.
              * 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.
              * business_rule_created - Triggered when a [business rule](/docs/api/business_rules) is [created](/docs/api/business_rules/create-a-business-rule).
              * subscription_advance_invoice_schedule_added - Triggered when an advance invoice is scheduled for a subscription.
              * vault_token_updated - Triggered when a vaulted payment method is updated.
              * virtual_bank_account_added - Sent when a virtual bank account is added for a customer.
              * subscription_movement_failed - Triggered when a subscription movement fails.
              * tax_withheld_deleted - Triggered when a tax withheld is deleted.
              * omnichannel_subscription_item_change_scheduled - Triggered when an omnichannel subscription item change is scheduled.
              * entitlement_overrides_updated - Triggered when an override entitlement is updated.
              * payment_refunded - Sent when a payment refund is made.
              * item_entitlements_updated - Triggered when item entitlements are updated for a feature.
              * payment_source_updated - Sent when the payment source is updated for a customer, or when a role is assigned to the payment source.
              * quote_created - Triggered when a quote is created.
              * feature_reactivated - Triggered when a feature `status` transitions to `active` for the second time or more.
              * credit_note_created - Sent when a credit note is created.
              * gift_expired - Triggered when a gift expires.
              * transaction_created - Triggered when a transaction is recorded.
              * payment_source_deleted - Sent when a payment source is deleted for a customer.
              * coupon_codes_added - Sent when coupon codes are added to a coupon set.
              * omnichannel_subscription_item_recovered - Triggered when an omnichannel subscription item is recovered from a grace period or dunning.
              * rule_created - Triggered when a rule is created.
              * subscription_activated - Sent after the subscription has been moved from the trial state to the active state.
              * customer_business_entity_changed - Sent when a customer's business entity is changed.
              * omnichannel_subscription_item_changed - Triggered when an omnichannel subscription item is changed.
              * omnichannel_subscription_item_grace_period_expired - Triggered when an omnichannel subscription item's grace period has expired.
              * subscription_ramp_updated - Triggered when a subscription ramp is updated.
              * business_rule_deactivated - Triggered when a [business rule](/docs/api/business_rules) is [deactivated](/docs/api/business_rules/deactivate-a-business-rule), so Chargebee stops evaluating it.
              * item_price_entitlements_removed - Triggered when item price entitlements are removed for a feature.
              * subscription_changed_with_backdating - Sent after the subscription's recurring items have been changed, with the change backdated.
              * rule_updated - Triggered when a rule is updated.
              * mrr_updated - Sent when the MRR or CMRR of a subscription changes.
              * feature_updated - Triggered when a feature is updated.
              * subscription_ramp_applied - Triggered when a subscription ramp is applied.
              * card_deleted - Sent when a card is deleted for a customer.
              * omnichannel_subscription_item_pause_scheduled - Triggered when an omnichannel subscription item is scheduled for pause.
              * sales_order_updated - Triggered when a sales order is updated.
              * subscription_cancellation_scheduled - Sent when a subscription is scheduled to be cancelled at the end of the current term.
              * subscription_deleted - Sent when a subscription has been deleted.
              * voucher_create_failed - Triggered when payment voucher creation fails.
              * omnichannel_subscription_item_dunning_expired - Triggered when an omnichannel subscription item's dunning has expired.
              * vault_token_deleted - Triggered when a vaulted payment method is deleted from the vault.
              * card_expiry_reminder - Sent when the customer's credit card is expiring soon. Sent 30 days before the expiry date.
              * subscription_resumption_scheduled - Triggered when the subscription resumption is scheduled.
              * vault_token_created - Triggered when a payment method is tokenized and stored in the vault.
              * omnichannel_subscription_item_resubscribed - Triggered when an omnichannel subscription item is resubscribed.
              * refund_initiated - Sent when a refund is initiated via direct debit.
              * omnichannel_subscription_item_downgraded - Triggered when an omnichannel subscription item is downgraded.
              * omnichannel_subscription_moved_in - Triggered when an omnichannel subscription is moved to another customer.
              * einvoice_updated - Triggered when an e-invoice is updated (for example when its status or provider responses change).
              * omnichannel_subscription_item_paused - Triggered when an omnichannel subscription item is paused.
              * omnichannel_subscription_item_scheduled_cancellation_removed - Triggered when a scheduled cancellation for an omnichannel subscription item is removed.
              * payment_schedules_created - Event triggered when new payment schedules are created for an invoice.
              * business_rules_applied - Triggered when [business rules](/docs/api/business_rules) are applied to an entity as part of a change to it, such as a quote being created or updated. The event carries a single `business_rules_applied` object that identifies the entity the rules were applied to, the `operation` that triggered them, and each rule that matched along with its version and the actions it produced. No event is sent when a change matches none of the rules.
              * subscription_advance_invoice_schedule_updated - Triggered when a scheduled advance invoice is updated for a subscription.
              * credit_note_created_with_backdating - Sent when a credit note is created with a past date as the credit note date.
              * unbilled_charges_created - Triggered when unbilled charges are created.
              * rule_deleted - Triggered when a rule is deleted.
              * attached_item_updated - Triggered when an attached item is updated.
              * payment_intent_created - Sent when a payment intent is created.
              * contract_term_completed - Triggered when a contract term is completed.
              * tax_withheld_recorded - Triggered when a tax withheld is recorded for an invoice.
              * business_rule_updated - Triggered when the draft of a [business rule](/docs/api/business_rules) is [updated](/docs/api/business_rules/update-a-business-rule-draft). Only the draft changes, so the version Chargebee evaluates is unaffected. [Releasing](/docs/api/business_rules/release-a-business-rule) the draft and [deleting](/docs/api/business_rules/delete-a-business-rule-draft) it do not send this event.
              * subscription_created - Sent when a new subscription is created.
            enum:
            - 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
            - einvoice_created
            - einvoice_updated
            - payment_schedules_created
            - payment_schedules_updated
            - payment_schedule_scheme_created
            - payment_schedule_scheme_deleted
            - subscription_renewal_reminder
            - add_usages_reminder
            - payment_due_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
            - item_family_created
            - item_family_updated
            - item_family_deleted
            - item_created
            - item_updated
            - item_deleted
            - item_price_created
            - item_price_updated
            - item_price_deleted
            - attached_item_created
            - attached_item_updated
            - attached_item_deleted
            - differential_price_created
            - differential_price_updated
            - differential_price_deleted
            - feature_created
            - feature_updated
            - feature_deleted
            - feature_activated
            - feature_reactivated
            - feature_archived
            - item_entitlements_updated
            - entitlement_overrides_updated
            - entitlement_overrides_removed
            - item_entitlements_removed
            - entitlement_overrides_auto_removed
            - subscription_entitlements_created
            - subscription_entitlements_updated
            - business_entity_created
            - business_entity_updated
            - business_entity_deleted
            - customer_business_entity_changed
            - subscription_business_entity_changed
            - payment_source_business_entity_changed
            - purchase_created
            - voucher_created
            - voucher_expired
            - voucher_create_failed
            - item_price_entitlements_updated
            - item_price_entitlements_removed
            - subscription_ramp_created
            - subscription_ramp_deleted
            - subscription_ramp_applied
            - subscription_ramp_drafted
            - subscription_ramp_updated
            - price_variant_created
            - price_variant_updated
            - price_variant_deleted
            - customer_entitlements_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
            - omnichannel_subscription_moved_in
            - omnichannel_transaction_created
            - alert_status_changed
            - omnichannel_subscription_item_updated
            - omnichannel_subscription_item_recovered
            - omnichannel_subscription_item_mrr_updated
            - ledger_account_balance_updated
            - grant_blocks_created
            - grant_blocks_updated
            - ledger_updated
            - business_rule_created
            - business_rule_updated
            - business_rule_activated
            - business_rule_deactivated
            - business_rule_deleted
            - business_rule_released
            - vault_token_created
            - vault_token_updated
            - vault_token_deleted
            - business_rules_applied
            - business_ruleset_created
            - business_ruleset_updated
            - business_ruleset_activated
            - business_ruleset_deactivated
            - business_ruleset_deleted
            example: null
          example: null
      required:
      - api_version
      - disabled
      - id
      - name
      - primary_url
      - url
      example: null
    WindowSize:
      type: string
      deprecated: false
      enum:
      - month
      - week
      - day
      - hour
      - minute
      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
    metered-feature-id:
      name: metered-feature-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
    custom-data-schema-id:
      name: custom-data-schema-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
    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`.
    credit-unit-id:
      name: credit-unit-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    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
    dispute-id:
      name: dispute-id
      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
    vaulted-payment-method-id:
      name: vaulted-payment-method-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    chargebee-business-entity-id:
      name: chargebee-business-entity-id
      in: header
      description: "If the site has multiple business entities, you can use this custom\
        \ HTTP header to specify the business entity for which Chargebee should perform\
        \ the operation."
      required: false
      style: simple
      explode: false
      schema:
        type: string
        description: "If the site has multiple business entities, you can use this\
          \ custom HTTP header to specify the business entity for which Chargebee\
          \ should perform the operation."
        maxLength: 50
    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
    chargebee-async-callback-url:
      name: chargebee-async-callback-url
      in: header
      description: "The callback URL where Chargebee will `POST` the async result.\
        \ Must be an `https://` URL and may embed basic-auth credentials, e.g. `https://username:password@example.com`."
      required: true
      style: simple
      explode: false
      schema:
        type: string
        format: uri
        description: "The callback URL where Chargebee will `POST` the async result.\
          \ Must be an `https://` URL and may embed basic-auth credentials, e.g. `https://username:password@example.com`."
        example: https://username:password@example.com
      x-cb-async-header: true
    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
    business-entity-transfer-id:
      name: business-entity-transfer-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
    item-billing-metric-id:
      name: item-billing-metric-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
    payment-schedule-scheme-id:
      name: payment-schedule-scheme-id
      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
    omnichannel-subscription-item-id:
      name: omnichannel-subscription-item-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
    omnichannel-one-time-order-id:
      name: omnichannel-one-time-order-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    Prefer:
      name: Prefer
      in: header
      description: Must be set to `respond-async`. Instructs Chargebee to process
        the request asynchronously and return `202 Accepted` immediately.
      required: true
      style: simple
      explode: false
      schema:
        type: string
        description: Must be set to `respond-async`. Instructs Chargebee to process
          the request asynchronously and return `202 Accepted` immediately.
        example: respond-async
      x-cb-async-header: true
    site-id:
      name: site-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    einvoice-id:
      name: einvoice-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
    business-rule-id:
      name: business-rule-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
    purchase-id:
      name: purchase-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    ledger-operation-id:
      name: ledger-operation-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
    omnichannel-subscription-id:
      name: omnichannel-subscription-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    approval-id:
      name: approval-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    price-variant-id:
      name: price-variant-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    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
    recorded-purchase-id:
      name: recorded-purchase-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
    chargebee-request-id:
      name: chargebee-request-id
      in: header
      description: "A client-generated unique identifier (UUID recommended) for this\
        \ request. Echoed back as `request.id` in the async callback payload, allowing\
        \ you to correlate each callback to its originating request."
      required: true
      style: simple
      explode: false
      schema:
        type: string
        description: "A client-generated unique identifier (UUID recommended) for\
          \ this request. Echoed back as `request.id` in the async callback payload,\
          \ allowing you to correlate each callback to its originating request."
        example: 7c9e2f4a-8b1d-4e6f-9a0c-3d5e7f9b1c2d
        maxLength: 100
      x-cb-async-header: true
    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
    business-ruleset-id:
      name: business-ruleset-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
    ramp-id:
      name: ramp-id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
    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: |
      Triggered when the subscription is scheduled to pause.
    post:
      summary: Triggered when the subscription is scheduled to pause.
      description: |
        Triggered when the subscription is scheduled to pause.
      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
  customer_business_entity_changed:
    post:
      summary: Triggered when a customer's business entity is changed
      operationId: onCustomer_business_entity_changedWebhook
      requestBody:
        description: Payload for customer_business_entity_changed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CustomerBusinessEntityChangedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_advance_invoice_schedule_added:
    description: |
      Triggered when advance invoice is scheduled for a subscription.
    post:
      summary: Triggered when advance invoice is scheduled for a subscription.
      description: |
        Triggered when advance invoice is scheduled for a subscription.
      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: |
      Triggered when a gift expires.
    post:
      summary: Triggered when a gift expires.
      description: |
        Triggered when a gift expires.
      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: |
      Triggered when a tax withheld is deleted.
    post:
      summary: Triggered when a tax withheld is deleted.
      description: |
        Triggered when a tax withheld is deleted.
      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
  unbilled_charges_deleted:
    description: |
      Triggered when unbilled charges are deleted
    post:
      summary: Triggered when unbilled charges are deleted
      description: |
        Triggered when unbilled charges are deleted
      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
  coupon_updated:
    description: |
      Triggered when a coupon is changed.
    post:
      summary: Triggered when a coupon is changed.
      description: |
        Triggered when a coupon is changed.
      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
  grant_blocks_created:
    description: |
      Triggered when one or more [grant blocks](/docs/api/grant_blocks) are created for a subscription unit.
      The event content includes the created `grant_blocks`.
    post:
      summary: Triggered when one or more grant blocks are created for a subscription
        unit.
      description: |
        Triggered when one or more [grant blocks](/docs/api/grant_blocks) are created for a subscription unit.
        The event content includes the created `grant_blocks`.
      operationId: onGrant_blocks_createdWebhook
      requestBody:
        description: Payload for grant_blocks_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GrantBlocksCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  product_updated:
    post:
      summary: Triggered when a product resource is updated successfully
      operationId: onProduct_updatedWebhook
      requestBody:
        description: Payload for product_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ProductUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: true
  omnichannel_subscription_item_reactivated:
    description: |
      Triggered when an omnichannel subscription item's refund is reversed.
    post:
      summary: Triggered when an omnichannel subscription item's refund is reversed
      description: |
        Triggered when an omnichannel subscription item's refund is reversed.
      operationId: onOmnichannel_subscription_item_reactivatedWebhook
      requestBody:
        description: Payload for omnichannel_subscription_item_reactivated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemReactivatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  omnichannel_subscription_item_renewed:
    description: |
      Triggered when an omnichannel subscription item is renewed.
    post:
      summary: Triggered when an omnichannel subscription item is renewed
      description: |
        Triggered when an omnichannel subscription item is renewed.
      operationId: onOmnichannel_subscription_item_renewedWebhook
      requestBody:
        description: Payload for omnichannel_subscription_item_renewed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemRenewedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  unbilled_charges_created:
    description: |
      Triggered when unbilled charges are created
    post:
      summary: Triggered when unbilled charges are created
      description: |
        Triggered when unbilled charges are created
      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: |
      Triggered when the subscription is resumed.
    post:
      summary: Triggered when the subscription is resumed.
      description: |
        Triggered when the subscription is resumed.
      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
  omnichannel_one_time_order_item_cancelled:
    post:
      summary: Triggered when an omnichannel one time order item is cancelled
      operationId: onOmnichannel_one_time_order_item_cancelledWebhook
      requestBody:
        description: Payload for omnichannel_one_time_order_item_cancelled event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelOneTimeOrderItemCancelledEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_cancelled:
    description: |
      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'.
    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: |
        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'.
      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
  business_rule_deleted:
    post:
      summary: Triggered when a business rule is deleted
      operationId: onBusiness_rule_deletedWebhook
      requestBody:
        description: Payload for business_rule_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BusinessRuleDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  item_entitlements_removed:
    description: |
      One or more `item_entitlement`s were removed for an `item` or a `feature`.
    post:
      summary: One or more `item_entitlement`s were removed for an `item` or a `feature`.
      description: |
        One or more `item_entitlement`s were removed for an `item` or a `feature`.
      operationId: onItem_entitlements_removedWebhook
      requestBody:
        description: Payload for item_entitlements_removed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ItemEntitlementsRemovedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  business_entity_created:
    description: |
      Triggered when a business entity is created
    post:
      summary: Triggered when a business entity is created
      description: |
        Triggered when a business entity is created
      operationId: onBusiness_entity_createdWebhook
      requestBody:
        description: Payload for business_entity_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BusinessEntityCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  coupon_set_updated:
    description: |
      Triggered when a coupon set is updated.
    post:
      summary: Triggered when a coupon set is updated.
      description: |
        Triggered when a coupon set is updated.
      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
  differential_price_updated:
    description: |
      Triggered when a differential price is updated.
    post:
      summary: Triggered when a differential price is updated.
      description: |
        Triggered when a differential price is updated.
      operationId: onDifferential_price_updatedWebhook
      requestBody:
        description: Payload for differential_price_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DifferentialPriceUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  omnichannel_subscription_item_paused:
    description: |
      Triggered when an omnichannel subscription item is paused.
    post:
      summary: Triggered when an omnichannel subscription item is paused
      description: |
        Triggered when an omnichannel subscription item is paused.
      operationId: onOmnichannel_subscription_item_pausedWebhook
      requestBody:
        description: Payload for omnichannel_subscription_item_paused event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemPausedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  entitlement_overrides_removed:
    description: |
      Triggered when one or more `entitlement_override` objects are removed. This is not triggered when Chargebee removes the objects automatically upon expiry.
    post:
      summary: Triggered when one or more `entitlement_override` objects are removed.
        This is not triggered when Chargebee removes the objects automatically upon
        expiry.
      description: |
        Triggered when one or more `entitlement_override` objects are removed. This is not triggered when Chargebee removes the objects automatically upon expiry.
      operationId: onEntitlement_overrides_removedWebhook
      requestBody:
        description: Payload for entitlement_overrides_removed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/EntitlementOverridesRemovedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_activated_with_backdating:
    description: |
      Triggered after the subscription changes to `active` from another `status`, while the change is backdated.
    post:
      summary: "Triggered after the subscription changes to `active` from another\
        \ `status`, while the change is backdated."
      description: |
        Triggered after the subscription changes to `active` from another `status`, while the change is backdated.
      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
  subscription_trial_end_reminder:
    description: |
      Triggered 6 days prior to the trial period's end date.
    post:
      summary: Triggered 6 days prior to the trial period's end date.
      description: |
        Triggered 6 days prior to the trial period's end date.
      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: |
      Triggered when shipping address is added or updated for a subscription.
    post:
      summary: Triggered when shipping address is added or updated for a subscription.
      description: |
        Triggered when shipping address is added or updated for a subscription.
      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
  voucher_create_failed:
    description: |
      Triggered when the Payment voucher Creation fails.
    post:
      summary: Triggered when the Payment voucher Creation fails.
      description: |
        Triggered when the Payment voucher Creation fails.
      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: |
      Triggered when a gift is claimed.
    post:
      summary: Triggered when a gift is claimed.
      description: |
        Triggered when a gift is claimed.
      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
  business_rules_applied:
    post:
      summary: Triggered when rules were applied to any entity. Carries a single business_rules_applied
        object with the applied business_rules properties.
      operationId: onBusiness_rules_appliedWebhook
      requestBody:
        description: Payload for business_rules_applied event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BusinessRulesAppliedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  customer_deleted:
    description: |
      Triggered when a customer is deleted.
    post:
      summary: Triggered when a customer is deleted.
      description: |
        Triggered when a customer is deleted.
      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
  refund_initiated:
    description: |
      Triggered when a refund is initiated using the `direct_debit` payment method, or when a transaction enters the `in_progress` status due to asynchronous processing at the payment gateway.
    post:
      summary: Triggered when a refund is initiated via direct debit.
      description: |
        Triggered when a refund is initiated using the `direct_debit` payment method, or when a transaction enters the `in_progress` status due to asynchronous processing at the payment gateway.
      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: |
      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.
    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: |
        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.
      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
  omnichannel_transaction_created:
    description: |
      Triggered when an omnichannel transaction is created.
    post:
      summary: Triggered when an omnichannel transaction is created
      description: |
        Triggered when an omnichannel transaction is created.
      operationId: onOmnichannel_transaction_createdWebhook
      requestBody:
        description: Payload for omnichannel_transaction_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelTransactionCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  add_usages_reminder:
    description: |
      Triggered on one day before term end of every month.
    post:
      summary: Triggered on one day before term end of every month.
      description: |
        Triggered on one day before term end of every month.
      operationId: onAdd_usages_reminderWebhook
      requestBody:
        description: Payload for add_usages_reminder event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AddUsagesReminderEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  voucher_created:
    description: |
      Triggered when a Payment voucher is created.
    post:
      summary: Triggered when a Payment voucher is created.
      description: |
        Triggered when a Payment voucher is created.
      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_schedules_created:
    post:
      summary: Event triggered when payment schedules are created for an invoice.
      operationId: onPayment_schedules_createdWebhook
      requestBody:
        description: Payload for payment_schedules_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PaymentSchedulesCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  feature_activated:
    description: |
      Triggered when a `feature` status transitions to `active` for the first time.
    post:
      summary: Triggered when a `feature` status transitions to `active` for the first
        time.
      description: |
        Triggered when a `feature` status transitions to `active` for the first time.
      operationId: onFeature_activatedWebhook
      requestBody:
        description: Payload for feature_activated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/FeatureActivatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  payment_source_locally_deleted:
    description: |
      Triggered when a payment source is deleted at Chargebee.
    post:
      summary: Triggered when a payment source is deleted at Chargebee.
      description: |
        Triggered when a payment source is deleted at Chargebee.
      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
  invoice_generated:
    description: |
      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.
    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: |
        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.
      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: |
      Triggered when a Payment voucher is Expired.
    post:
      summary: Triggered when a Payment voucher is Expired.
      description: |
        Triggered when a Payment voucher is Expired.
      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: |
      Triggered when a authorization transaction is created.
    post:
      summary: Triggered when a authorization transaction is created.
      description: |
        Triggered when a authorization transaction is created.
      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
  gift_scheduled:
    description: |
      Triggered when a new gift is created.
    post:
      summary: Triggered when a new gift is created.
      description: |
        Triggered when a new gift is created.
      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_changes_scheduled:
    description: |
      Triggered when subscription changes are scheduled for later. Changes will be applied at the end of current term.
    post:
      summary: Triggered when subscription changes are scheduled for later. Changes
        will be applied at the end of current term.
      description: |
        Triggered when subscription changes are scheduled for later. Changes will be applied at the end of current term.
      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: |
      Triggered when a subscription is changed with changes_scheduled_at set to a value in the past.
    post:
      summary: Triggered when a subscription is changed with changes_scheduled_at
        set to a value in the past.
      description: |
        Triggered when a subscription is changed with changes_scheduled_at set to a value in the past.
      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
  variant_created:
    post:
      summary: Triggered when a product variant resource is created successfully
      operationId: onVariant_createdWebhook
      requestBody:
        description: Payload for variant_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/VariantCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: true
  omnichannel_subscription_item_changed:
    description: |
      Triggered when an omnichannel subscription item is changed.
    post:
      summary: Triggered when an omnichannel subscription item is changed
      description: |
        Triggered when an omnichannel subscription item is changed.
      operationId: onOmnichannel_subscription_item_changedWebhook
      requestBody:
        description: Payload for omnichannel_subscription_item_changed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemChangedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  gift_unclaimed:
    description: |
      Triggered when a new gift is unclaimed and is ready to be claimed.
    post:
      summary: Triggered when a new gift is unclaimed and is ready to be claimed.
      description: |
        Triggered when a new gift is unclaimed and is ready to be claimed.
      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: |
      Triggered when a virtual bank account is added.
    post:
      summary: Triggered when a virtual bank account is added.
      description: |
        Triggered when a virtual bank account is added.
      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: |
      Triggered when a payment intent is created.
    post:
      summary: Triggered when a payment intent is created.
      description: |
        Triggered when a payment intent is created.
      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
  omnichannel_subscription_item_updated:
    description: |
      Triggered when an omnichannel subscription item is updated.
    post:
      summary: Triggered when an omnichannel subscription item is updated
      description: |
        Triggered when an omnichannel subscription item is updated.
      operationId: onOmnichannel_subscription_item_updatedWebhook
      requestBody:
        description: Payload for omnichannel_subscription_item_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  credit_note_created_with_backdating:
    description: |
      Triggered when a credit note is created such that generated_at is a value in the past.
    post:
      summary: Triggered when a credit note is created such that generated_at is a
        value in the past.
      description: |
        Triggered when a credit note is created such that generated_at is a value in the past.
      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: |
      Triggered when contract term is terminated.
    post:
      summary: Triggered when contract term is terminated.
      description: |
        Triggered when contract term is terminated.
      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
  item_family_updated:
    description: |
      Triggered when an item family is updated.
    post:
      summary: Triggered when an item family is updated.
      description: |
        Triggered when an item family is updated.
      operationId: onItem_family_updatedWebhook
      requestBody:
        description: Payload for item_family_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ItemFamilyUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  order_created:
    description: |
      Triggered when an order is generated.
    post:
      summary: Triggered when an order is generated.
      description: |
        Triggered when an order is generated.
      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
  price_variant_deleted:
    description: |
      Triggered when a price variant resource is deleted successfully
    post:
      summary: Triggered when a price variant is deleted.
      description: |
        Triggered when a price variant resource is deleted successfully
      operationId: onPrice_variant_deletedWebhook
      requestBody:
        description: Payload for price_variant_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PriceVariantDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  alert_status_changed:
    description: |
      Triggered when an alert's runtime status for a subscription changes between `IN_ALARM` and `WITHIN_LIMIT`.
      This indicates a change in the subscription's usage relative to the alert threshold and applies only to usage-based billing.
    post:
      summary: Triggered when the status for an alert changes
      description: |
        Triggered when an alert's runtime status for a subscription changes between `IN_ALARM` and `WITHIN_LIMIT`.
        This indicates a change in the subscription's usage relative to the alert threshold and applies only to usage-based billing.
      operationId: onAlert_status_changedWebhook
      requestBody:
        description: Payload for alert_status_changed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AlertStatusChangedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_movement_failed:
    description: |
      Triggered when the subscription movement fails during moving in or out of a subscription from one customer to another asynchronously.
    post:
      summary: Triggered when a subscription movement failed
      description: |
        Triggered when the subscription movement fails during moving in or out of a subscription from one customer to another asynchronously.
      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
  business_ruleset_updated:
    post:
      summary: Triggered when a business ruleset is updated
      operationId: onBusiness_ruleset_updatedWebhook
      requestBody:
        description: Payload for business_ruleset_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BusinessRulesetUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  customer_moved_in:
    description: |
      Triggered when a customer is copied from another site.
    post:
      summary: Triggered when a customer is copied from another site.
      description: |
        Triggered when a customer is copied from another site.
      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
  subscription_advance_invoice_schedule_updated:
    description: |
      Triggered when scheduled advance invoice is updated for a subscription.
    post:
      summary: Triggered when scheduled advance invoice is updated for a subscription.
      description: |
        Triggered when scheduled advance invoice is updated for a subscription.
      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
  item_deleted:
    description: |
      Triggered when an item is deleted.
    post:
      summary: Triggered when an item is deleted.
      description: |
        Triggered when an item is deleted.
      operationId: onItem_deletedWebhook
      requestBody:
        description: Payload for item_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ItemDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_ramp_drafted:
    description: |
      Triggered when a ramp is moved to draft status.
    post:
      summary: Triggered when a ramp is drafted.
      description: |
        Triggered when a ramp is moved to draft status.
      operationId: onSubscription_ramp_draftedWebhook
      requestBody:
        description: Payload for subscription_ramp_drafted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionRampDraftedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  business_rule_created:
    post:
      summary: Triggered when a business rule is created
      operationId: onBusiness_rule_createdWebhook
      requestBody:
        description: Payload for business_rule_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BusinessRuleCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  vault_token_updated:
    post:
      summary: Triggered when a vaulted payment method row is updated
      operationId: onVault_token_updatedWebhook
      requestBody:
        description: Payload for vault_token_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/VaultTokenUpdatedEvent"
      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
  einvoice_created:
    description: |
      Triggered when an e-invoice is created for an invoice or credit note.
    post:
      summary: Triggered when an e-invoice is created for an invoice or credit note.
      description: |
        Triggered when an e-invoice is created for an invoice or credit note.
      operationId: onEinvoice_createdWebhook
      requestBody:
        description: Payload for einvoice_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/EinvoiceCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  omnichannel_subscription_item_recovered:
    description: |
      Triggered when an omnichannel subscription item recovers from a billing issue and is active again.
    post:
      summary: Triggered when an omnichannel subscription item is recovered from grace
        period or dunning
      description: |
        Triggered when an omnichannel subscription item recovers from a billing issue and is active again.
      operationId: onOmnichannel_subscription_item_recoveredWebhook
      requestBody:
        description: Payload for omnichannel_subscription_item_recovered event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemRecoveredEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  item_entitlements_updated:
    description: |
      One or more `entitlement`s were added or updated for an `item`.
    post:
      summary: One or more `item_entitlement`s were added or updated for an `item`
        or a `feature`.
      description: |
        One or more `entitlement`s were added or updated for an `item`.
      operationId: onItem_entitlements_updatedWebhook
      requestBody:
        description: Payload for item_entitlements_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ItemEntitlementsUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  token_consumed:
    description: |
      Triggered when a nonce is consumed.
    post:
      summary: Triggered when a nonce is consumed.
      description: |
        Triggered when a nonce is consumed.
      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
  hierarchy_deleted:
    description: |
      Triggered when a hierarchy is deleted.
    post:
      summary: Triggered when a hierarchy is deleted.
      description: |
        Triggered when a hierarchy is deleted.
      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
  vault_token_deleted:
    post:
      summary: Triggered when a vaulted payment method is soft-deleted from the vault
      operationId: onVault_token_deletedWebhook
      requestBody:
        description: Payload for vault_token_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/VaultTokenDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_cancellation_scheduled:
    description: |
      Triggered when subscription is scheduled to cancel at end of current term.
    post:
      summary: Triggered when subscription is scheduled to cancel at end of current
        term.
      description: |
        Triggered when subscription is scheduled to cancel at end of current term.
      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
  subscription_renewed:
    description: |
      Triggered when the subscription is renewed from the current term.
    post:
      summary: Triggered when the subscription is renewed from the current term.
      description: |
        Triggered when the subscription is renewed from the current term.
      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
  feature_updated:
    description: |
      Triggered when a `feature` is updated. Note: This event is not triggered when only the `status` of the feature has changed.
    post:
      summary: "Triggered when a `feature` is updated. Note: This event is not triggered\
        \ when only the `status` of the feature has changed."
      description: |
        Triggered when a `feature` is updated. Note: This event is not triggered when only the `status` of the feature has changed.
      operationId: onFeature_updatedWebhook
      requestBody:
        description: Payload for feature_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/FeatureUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  feature_deleted:
    description: |
      Triggered when a `feature` is deleted.
    post:
      summary: Triggered when a `feature` is deleted.
      description: |
        Triggered when a `feature` is deleted.
      operationId: onFeature_deletedWebhook
      requestBody:
        description: Payload for feature_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/FeatureDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  item_family_created:
    description: |
      Triggered when an item family is created.
    post:
      summary: Triggered when an item family is created.
      description: |
        Triggered when an item family is created.
      operationId: onItem_family_createdWebhook
      requestBody:
        description: Payload for item_family_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ItemFamilyCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  omnichannel_subscription_item_scheduled_change_removed:
    description: |
      Triggered when an omnichannel subscription item scheduled change is removed.
    post:
      summary: Triggered when an omnichannel subscription item scheduled change is
        removed
      description: |
        Triggered when an omnichannel subscription item scheduled change is removed.
      operationId: onOmnichannel_subscription_item_scheduled_change_removedWebhook
      requestBody:
        description: Payload for omnichannel_subscription_item_scheduled_change_removed
          event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemScheduledChangeRemovedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  omnichannel_subscription_item_resumed:
    description: |
      Triggered when an omnichannel subscription item is resumed.
    post:
      summary: Triggered when an omnichannel subscription item is resumed
      description: |
        Triggered when an omnichannel subscription item is resumed.
      operationId: onOmnichannel_subscription_item_resumedWebhook
      requestBody:
        description: Payload for omnichannel_subscription_item_resumed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemResumedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  purchase_created:
    description: |
      Triggered when a purchase resource is created successfully
    post:
      summary: Triggered when a purchase resource is created successfully
      description: |
        Triggered when a purchase resource is created successfully
      operationId: onPurchase_createdWebhook
      requestBody:
        description: Payload for purchase_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PurchaseCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  entitlement_overrides_updated:
    description: |
      One or more `entitlement_override`s for a subscription were added or updated.
    post:
      summary: One or more `entitlement_override`s for a subscription were added or
        updated.
      description: |
        One or more `entitlement_override`s for a subscription were added or updated.
      operationId: onEntitlement_overrides_updatedWebhook
      requestBody:
        description: Payload for entitlement_overrides_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/EntitlementOverridesUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  item_family_deleted:
    description: |
      Triggered when an item family is deleted.
    post:
      summary: Triggered when an item family is deleted.
      description: |
        Triggered when an item family is deleted.
      operationId: onItem_family_deletedWebhook
      requestBody:
        description: Payload for item_family_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ItemFamilyDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_resumption_scheduled:
    description: |
      Triggered when the subscription is scheduled to resume.
    post:
      summary: Triggered when the subscription is scheduled to resume.
      description: |
        Triggered when the subscription is scheduled to resume.
      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
  feature_reactivated:
    description: |
      Triggered when a `feature` status transitions to `active` for the second time or more.
    post:
      summary: Triggered when a `feature` status transitions to `active` for the second
        time or more.
      description: |
        Triggered when a `feature` status transitions to `active` for the second time or more.
      operationId: onFeature_reactivatedWebhook
      requestBody:
        description: Payload for feature_reactivated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/FeatureReactivatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  coupon_codes_deleted:
    description: |
      Triggered when coupon codes are deleted in coupon set.
    post:
      summary: Triggered when coupon codes are deleted in coupon set.
      description: |
        Triggered when coupon codes are deleted in coupon set.
      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: |
      Triggered when the card for a customer has expired.
    post:
      summary: Triggered when the card for a customer has expired.
      description: |
        Triggered when the card for a customer has expired.
      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: |
      Triggered when a credit note is updated.
    post:
      summary: Triggered when a credit note is updated.
      description: |
        Triggered when a credit note is updated.
      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
  omnichannel_subscription_item_downgraded:
    description: |
      Triggered when an omnichannel subscription item is downgraded.
    post:
      summary: Triggered when an omnichannel subscription item is downgraded
      description: |
        Triggered when an omnichannel subscription item is downgraded.
      operationId: onOmnichannel_subscription_item_downgradedWebhook
      requestBody:
        description: Payload for omnichannel_subscription_item_downgraded event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemDowngradedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  business_ruleset_deactivated:
    post:
      summary: Triggered when a business ruleset is deactivated
      operationId: onBusiness_ruleset_deactivatedWebhook
      requestBody:
        description: Payload for business_ruleset_deactivated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BusinessRulesetDeactivatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  price_variant_updated:
    description: |
      Triggered when a price variant resource is updated successfully
    post:
      summary: Triggered when a price variant is updated.
      description: |
        Triggered when a price variant resource is updated successfully
      operationId: onPrice_variant_updatedWebhook
      requestBody:
        description: Payload for price_variant_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PriceVariantUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  promotional_credits_deducted:
    description: |
      Triggered when promotional credit is deducted.
    post:
      summary: Triggered when promotional credit is deducted.
      description: |
        Triggered when promotional credit is deducted.
      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
  subscription_ramp_applied:
    description: |
      Triggered when a ramp is executed successfully.
    post:
      summary: Triggered when a ramp is applied.
      description: |
        Triggered when a ramp is executed successfully.
      operationId: onSubscription_ramp_appliedWebhook
      requestBody:
        description: Payload for subscription_ramp_applied event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionRampAppliedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  business_ruleset_deleted:
    post:
      summary: Triggered when a business ruleset is deleted
      operationId: onBusiness_ruleset_deletedWebhook
      requestBody:
        description: Payload for business_ruleset_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BusinessRulesetDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_paused:
    description: |
      Triggered when the subscription is paused.
    post:
      summary: Triggered when the subscription is paused.
      description: |
        Triggered when the subscription is paused.
      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: |
      Triggered when an order reaches it's order date.
    post:
      summary: Triggered when an order reaches it's order date.
      description: |
        Triggered when an order reaches it's order date.
      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
  feature_created:
    description: |
      Triggered when a `feature` is created.
    post:
      summary: Triggered when a `feature` is created.
      description: |
        Triggered when a `feature` is created.
      operationId: onFeature_createdWebhook
      requestBody:
        description: Payload for feature_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/FeatureCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  transaction_deleted:
    description: |
      Triggered when a transaction is deleted.
    post:
      summary: Triggered when a transaction is deleted.
      description: |
        Triggered when a transaction is deleted.
      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: |
      Triggered when a credit note is created.
    post:
      summary: Triggered when a credit note is created.
      description: |
        Triggered when a credit note is created.
      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
  omnichannel_subscription_item_resubscribed:
    description: |
      Triggered when an omnichannel subscription item is resubscribed.
    post:
      summary: Triggered when an omnichannel subscription item is resubscribed
      description: |
        Triggered when an omnichannel subscription item is resubscribed.
      operationId: onOmnichannel_subscription_item_resubscribedWebhook
      requestBody:
        description: Payload for omnichannel_subscription_item_resubscribed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemResubscribedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  record_purchase_failed:
    description: |
      Triggered when the record a purchase API fails to create an omnichannel subscription.
    post:
      summary: Triggered when an omnichannel record purchase is failed
      description: |
        Triggered when the record a purchase API fails to create an omnichannel subscription.
      operationId: onRecord_purchase_failedWebhook
      requestBody:
        description: Payload for record_purchase_failed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RecordPurchaseFailedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  item_created:
    description: |
      Triggered when an item is created.
    post:
      summary: Triggered when an item is created.
      description: |
        Triggered when an item is created.
      operationId: onItem_createdWebhook
      requestBody:
        description: Payload for item_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ItemCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  business_ruleset_created:
    post:
      summary: Triggered when a business ruleset is created
      operationId: onBusiness_ruleset_createdWebhook
      requestBody:
        description: Payload for business_ruleset_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BusinessRulesetCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  transaction_updated:
    description: |
      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.
    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: |
        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.
      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
  variant_deleted:
    post:
      summary: Triggered when a product variant resource is deleted successfully
      operationId: onVariant_deletedWebhook
      requestBody:
        description: Payload for variant_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/VariantDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: true
  mrr_updated:
    description: |
      Triggered when either of MRR or CMRR is changed.
    post:
      summary: Triggered when either of MRR or CMRR is changed.
      description: |
        Triggered when either of MRR or CMRR is changed.
      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
  unbilled_charges_invoiced:
    description: |
      Triggered when unbilled charges are invoiced
    post:
      summary: Triggered when unbilled charges are invoiced
      description: |
        Triggered when unbilled charges are invoiced
      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
  item_price_updated:
    description: |
      Triggered when an item price is updated.
    post:
      summary: Triggered when an item price is updated.
      description: |
        Triggered when an item price is updated.
      operationId: onItem_price_updatedWebhook
      requestBody:
        description: Payload for item_price_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ItemPriceUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  coupon_codes_updated:
    description: |
      Triggered when coupon codes are updated in coupon set.
    post:
      summary: Triggered when coupon codes are updated in coupon set.
      description: |
        Triggered when coupon codes are updated in coupon set.
      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: |
      Triggered when the virtual bank account is updated.
    post:
      summary: Triggered when the virtual bank account is updated.
      description: |
        Triggered when the virtual bank account is updated.
      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: |
      Triggered when contract term is created.
    post:
      summary: Triggered when contract term is created.
      description: |
        Triggered when contract term is created.
      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: |
      Triggered when the subscription's recurring items are changed.
    post:
      summary: Triggered when the subscription's recurring items are changed.
      description: |
        Triggered when the subscription's recurring items are changed.
      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
  payment_failed:
    description: |
      Triggered when the payment collection fails.
    post:
      summary: Triggered when the payment collection fails.
      description: |
        Triggered when the payment collection fails.
      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: |
      Triggered when a credit note is deleted.
    post:
      summary: Triggered when a credit note is deleted.
      description: |
        Triggered when a credit note is deleted.
      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: |
      Triggered when a tax withheld is refunded.
    post:
      summary: Triggered when a tax withheld is refunded.
      description: |
        Triggered when a tax withheld is refunded.
      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: |
      Triggered when contract term is completed.
    post:
      summary: Triggered when contract term is completed.
      description: |
        Triggered when contract term is completed.
      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
  payment_schedules_updated:
    post:
      summary: Event triggered when payment schedules are updated.
      operationId: onPayment_schedules_updatedWebhook
      requestBody:
        description: Payload for payment_schedules_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PaymentSchedulesUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  omnichannel_subscription_item_expired:
    description: |
      Triggered when an omnichannel subscription item is expired.
    post:
      summary: Triggered when an omnichannel subscription item expires
      description: |
        Triggered when an omnichannel subscription item is expired.
      operationId: onOmnichannel_subscription_item_expiredWebhook
      requestBody:
        description: Payload for omnichannel_subscription_item_expired event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemExpiredEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  card_updated:
    description: |
      Triggered when the card is updated for a customer.
    post:
      summary: Triggered when the card is updated for a customer.
      description: |
        Triggered when the card is updated for a customer.
      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: |
      Triggered when a customer is created.
    post:
      summary: Triggered when a customer is created.
      description: |
        Triggered when a customer is created.
      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
  subscription_renewal_reminder:
    description: |
      Triggered 3 days before each subscription's renewal.
    post:
      summary: Triggered 3 days before each subscription's renewal.
      description: |
        Triggered 3 days before each subscription's renewal.
      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
  omnichannel_subscription_item_mrr_updated:
    description: |
      Triggered when the MRR (Monthly Recurring Revenue) computed for an omnichannel subscription item changes, for example due to a renewal, a price or offer change, or a status transition that affects revenue.
      Each occurrence delivers a new immutable [`omnichannel_subscription_item_metric`](/docs/api/omnichannel_subscription_item_metrics) snapshot.
      The event content includes the related [`omnichannel_subscription`](/docs/api/omnichannel_subscriptions), [`omnichannel_subscription_item`](/docs/api/omnichannel_subscription_items), and [`omnichannel_subscription_item_metric`](/docs/api/omnichannel_subscription_item_metrics).
    post:
      summary: Triggered when an omnichannel subscription item mrr is updated
      description: |
        Triggered when the MRR (Monthly Recurring Revenue) computed for an omnichannel subscription item changes, for example due to a renewal, a price or offer change, or a status transition that affects revenue.
        Each occurrence delivers a new immutable [`omnichannel_subscription_item_metric`](/docs/api/omnichannel_subscription_item_metrics) snapshot.
        The event content includes the related [`omnichannel_subscription`](/docs/api/omnichannel_subscriptions), [`omnichannel_subscription_item`](/docs/api/omnichannel_subscription_items), and [`omnichannel_subscription_item_metric`](/docs/api/omnichannel_subscription_item_metrics).
      operationId: onOmnichannel_subscription_item_mrr_updatedWebhook
      requestBody:
        description: Payload for omnichannel_subscription_item_mrr_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemMrrUpdatedEvent"
      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
  payment_due_reminder:
    post:
      summary: "Triggered when an invoice in payment_due or not_paid [status](https://apidocs.chargebee.com/docs/api/invoices/invoice-object#status)\
        \ remains unpaid for a configured number of days after its due date."
      operationId: onPayment_due_reminderWebhook
      requestBody:
        description: Payload for payment_due_reminder event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PaymentDueReminderEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  order_delivered:
    description: |
      Triggered when an order is delivered.
    post:
      summary: Triggered when an order is delivered.
      description: |
        Triggered when an order is delivered.
      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
  omnichannel_subscription_item_cancellation_scheduled:
    description: |
      Triggered when an omnichannel subscription item is scheduled for cancellation.
    post:
      summary: Triggered when an omnichannel subscription item is scheduled for cancellation
      description: |
        Triggered when an omnichannel subscription item is scheduled for cancellation.
      operationId: onOmnichannel_subscription_item_cancellation_scheduledWebhook
      requestBody:
        description: Payload for omnichannel_subscription_item_cancellation_scheduled
          event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemCancellationScheduledEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  omnichannel_subscription_item_grace_period_expired:
    description: |
      Triggered when an omnichannel subscription item's grace period has expired.
    post:
      summary: Triggered when an omnichannel subscription item's grace period has
        expired
      description: |
        Triggered when an omnichannel subscription item's grace period has expired.
      operationId: onOmnichannel_subscription_item_grace_period_expiredWebhook
      requestBody:
        description: Payload for omnichannel_subscription_item_grace_period_expired
          event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemGracePeriodExpiredEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  coupon_codes_added:
    description: |
      Triggered when coupon codes are added in coupon set.
    post:
      summary: Triggered when coupon codes are added in coupon set.
      description: |
        Triggered when coupon codes are added in coupon set.
      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
  gift_cancelled:
    description: |
      Triggered when gift is cancelled.
    post:
      summary: Triggered when gift is cancelled.
      description: |
        Triggered when gift is cancelled.
      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
  order_cancelled:
    description: |
      Triggered when an order is cancelled.
    post:
      summary: Triggered when an order is cancelled.
      description: |
        Triggered when an order is cancelled.
      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: |
      Triggered when a coupon is deleted.
    post:
      summary: Triggered when a coupon is deleted.
      description: |
        Triggered when a coupon is deleted.
      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: |
      Triggered when scheduled change for the subscription is removed.
    post:
      summary: Triggered when scheduled change for the subscription is removed.
      description: |
        Triggered when scheduled change for the subscription is removed.
      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: |
      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.
    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: |
        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.
      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
  product_deleted:
    post:
      summary: Triggered when a product resource is deleted successfully
      operationId: onProduct_deletedWebhook
      requestBody:
        description: Payload for product_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ProductDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: true
  entitlement_overrides_auto_removed:
    description: |
      When a limited period `entitlement_override` expires, it is no longer returned. No event is immediately triggered for it. However, after expiry, the `entitlement_override` record gets deleted within 12 hours, triggering the `entitlement_overrides_auto_removed` event. Therefore, this event can be considered a delayed notification for one or more `entitlement_overrides` having expired.
    post:
      summary: "When a limited period `entitlement_override` expires, it is no longer\
        \ returned. No event is immediately triggered for it. However, after expiry,\
        \ the `entitlement_override` record gets deleted within 12 hours, triggering\
        \ the `entitlement_overrides_auto_removed` event. Therefore, this event can\
        \ be considered a delayed notification for one or more `entitlement_overrides`\
        \ having expired."
      description: |
        When a limited period `entitlement_override` expires, it is no longer returned. No event is immediately triggered for it. However, after expiry, the `entitlement_override` record gets deleted within 12 hours, triggering the `entitlement_overrides_auto_removed` event. Therefore, this event can be considered a delayed notification for one or more `entitlement_overrides` having expired.
      operationId: onEntitlement_overrides_auto_removedWebhook
      requestBody:
        description: Payload for entitlement_overrides_auto_removed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/EntitlementOverridesAutoRemovedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  business_ruleset_activated:
    post:
      summary: Triggered when a business ruleset is activated
      operationId: onBusiness_ruleset_activatedWebhook
      requestBody:
        description: Payload for business_ruleset_activated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BusinessRulesetActivatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  omnichannel_subscription_item_upgraded:
    description: |
      Triggered when an omnichannel subscription item is upgraded.
    post:
      summary: Triggered when an omnichannel subscription item is upgraded
      description: |
        Triggered when an omnichannel subscription item is upgraded.
      operationId: onOmnichannel_subscription_item_upgradedWebhook
      requestBody:
        description: Payload for omnichannel_subscription_item_upgraded event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemUpgradedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_business_entity_changed:
    post:
      summary: Triggered when a subscription's business entity is changed
      operationId: onSubscription_business_entity_changedWebhook
      requestBody:
        description: Payload for subscription_business_entity_changed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionBusinessEntityChangedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  omnichannel_one_time_order_created:
    post:
      summary: Triggered when an omnichannel one time order is created
      operationId: onOmnichannel_one_time_order_createdWebhook
      requestBody:
        description: Payload for omnichannel_one_time_order_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelOneTimeOrderCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  payment_source_deleted:
    description: |
      Triggered when a payment source is deleted.
    post:
      summary: Triggered when a payment source is deleted.
      description: |
        Triggered when a payment source is deleted.
      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
  omnichannel_subscription_item_cancelled:
    description: |
      Triggered when an omnichannel subscription item is cancelled.
    post:
      summary: Triggered when an omnichannel subscription item is cancelled
      description: |
        Triggered when an omnichannel subscription item is cancelled.
      operationId: onOmnichannel_subscription_item_cancelledWebhook
      requestBody:
        description: Payload for omnichannel_subscription_item_cancelled event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemCancelledEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  quote_deleted:
    description: |
      Event triggered when a new quote is deleted.
    post:
      summary: Event triggered when a new quote is deleted.
      description: |
        Event triggered when a new quote is deleted.
      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: |
      Triggered when changes are made to a finalized invoice, including voiding, deletion, invoice address updates, status changes, and payment changes such as applying or removing a payment, applying or removing a credit, and credit note creation. `pending_invoice_updated` is triggered for changes specific to pending invoices; invoice_updated covers all other invoice changes.
    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: |
        Triggered when changes are made to a finalized invoice, including voiding, deletion, invoice address updates, status changes, and payment changes such as applying or removing a payment, applying or removing a credit, and credit note creation. `pending_invoice_updated` is triggered for changes specific to pending invoices; invoice_updated covers all other invoice changes.
      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
  subscription_advance_invoice_schedule_removed:
    description: |
      Triggered when scheduled advance invoice is removed for a subscription.
    post:
      summary: Triggered when scheduled advance invoice is removed for a subscription.
      description: |
        Triggered when scheduled advance invoice is removed for a subscription.
      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
  card_deleted:
    description: |
      Triggered when a card is deleted for a customer.
    post:
      summary: Triggered when a card is deleted for a customer.
      description: |
        Triggered when a card is deleted for a customer.
      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: |
      Triggered when an order reaches it's shipping date.
    post:
      summary: Triggered when an order reaches it's shipping date.
      description: |
        Triggered when an order reaches it's shipping date.
      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
  variant_updated:
    post:
      summary: Triggered when a product variant resource is updated successfully
      operationId: onVariant_updatedWebhook
      requestBody:
        description: Payload for variant_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/VariantUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: true
  subscription_moved_out:
    description: |
      Triggered when the subscription is moving out from one customer to another asynchronously.
    post:
      summary: Triggered when a subscription moved to other customer
      description: |
        Triggered when the subscription is moving out from one customer to another asynchronously.
      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
  payment_schedule_scheme_created:
    post:
      summary: Event triggered when a new payment schedule scheme is created
      operationId: onPayment_schedule_scheme_createdWebhook
      requestBody:
        description: Payload for payment_schedule_scheme_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PaymentScheduleSchemeCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  business_entity_updated:
    description: |
      Triggered when a business entity is changed
    post:
      summary: Triggered when a business entity is changed
      description: |
        Triggered when a business entity is changed
      operationId: onBusiness_entity_updatedWebhook
      requestBody:
        description: Payload for business_entity_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BusinessEntityUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_scheduled_resumption_removed:
    description: |
      Triggered when scheduled resumption is removed for the subscription.
    post:
      summary: Triggered when scheduled resumption is removed for the subscription.
      description: |
        Triggered when scheduled resumption is removed for the subscription.
      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: |
      Triggered when a payment is initiated using the `direct_debit` payment method, or when a transaction enters the `in_progress` status due to asynchronous processing at the payment gateway.
    post:
      summary: Triggered when a payment is initiated via direct debit.
      description: |
        Triggered when a payment is initiated using the `direct_debit` payment method, or when a transaction enters the `in_progress` status due to asynchronous processing at the payment gateway.
      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
  feature_archived:
    description: |
      Triggered when a `feature` status transitions to `archived`.
    post:
      summary: Triggered when a `feature` status transitions to `archived`.
      description: |
        Triggered when a `feature` status transitions to `archived`.
      operationId: onFeature_archivedWebhook
      requestBody:
        description: Payload for feature_archived event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/FeatureArchivedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_reactivated_with_backdating:
    description: |
      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.
    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: |
        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.
      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
  omnichannel_subscription_imported:
    description: |
      Triggered when an omnichannel subscription is imported.
    post:
      summary: Triggered when an omnichannel subscription is imported
      description: |
        Triggered when an omnichannel subscription is imported.
      operationId: onOmnichannel_subscription_importedWebhook
      requestBody:
        description: Payload for omnichannel_subscription_imported event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionImportedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  token_expired:
    description: |
      Triggered when a nonce is expired.
    post:
      summary: Triggered when a nonce is expired.
      description: |
        Triggered when a nonce is expired.
      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: |
      Triggered when a card is added for a customer.
    post:
      summary: Triggered when a card is added for a customer.
      description: |
        Triggered when a card is added for a customer.
      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: |
      Triggered when a coupon is created.
    post:
      summary: Triggered when a coupon is created.
      description: |
        Triggered when a coupon is created.
      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
  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
  item_price_entitlements_updated:
    description: |
      One or more `entitlement`s were added or updated for an `item_price`.
    post:
      summary: One or more `item_price_entitlement`s were added or updated for an
        `item_price` or a `feature`.
      description: |
        One or more `entitlement`s were added or updated for an `item_price`.
      operationId: onItem_price_entitlements_updatedWebhook
      requestBody:
        description: Payload for item_price_entitlements_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ItemPriceEntitlementsUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  item_price_deleted:
    description: |
      Triggered when an item price is deleted.
    post:
      summary: Triggered when an item price is deleted.
      description: |
        Triggered when an item price is deleted.
      operationId: onItem_price_deletedWebhook
      requestBody:
        description: Payload for item_price_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ItemPriceDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  virtual_bank_account_deleted:
    description: |
      Triggered when a virtual bank account is deleted.
    post:
      summary: Triggered when a virtual bank account is deleted.
      description: |
        Triggered when a virtual bank account is deleted.
      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
  payment_schedule_scheme_deleted:
    post:
      summary: Event triggered when a payment schedule scheme is deleted
      operationId: onPayment_schedule_scheme_deletedWebhook
      requestBody:
        description: Payload for payment_schedule_scheme_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PaymentScheduleSchemeDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_created:
    description: |
      Triggered when a new subscription is created.
    post:
      summary: Triggered when a new subscription is created.
      description: |
        Triggered when a new subscription is created.
      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
  subscription_entitlements_created:
    description: |
      Triggered on subscription creation, alongside the subscription_created event whenever the subscription has subscription_entitlements. The event payload contains the first 100 subscription_entitlements. The has_next attribute is set to true if more than 100 subscription entitlements are available. You can retrieve the next page by calling the "List subscription entitlements" endpoint, passing the offset parameter as 1.
    post:
      summary: "Triggered on subscription creation, alongside the subscription_created\
        \ event whenever the subscription has subscription_entitlements. The event\
        \ payload contains the first 100 subscription_entitlements. The has_next attribute\
        \ is set to true if more than 100 subscription entitlements are available.\
        \ You can retrieve the next page by calling the “List subscription entitlements”\
        \ endpoint, passing the offset parameter as 1."
      description: |
        Triggered on subscription creation, alongside the subscription_created event whenever the subscription has subscription_entitlements. The event payload contains the first 100 subscription_entitlements. The has_next attribute is set to true if more than 100 subscription entitlements are available. You can retrieve the next page by calling the "List subscription entitlements" endpoint, passing the offset parameter as 1.
      operationId: onSubscription_entitlements_createdWebhook
      requestBody:
        description: Payload for subscription_entitlements_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionEntitlementsCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  order_returned:
    description: |
      Triggered when an order is returned.
    post:
      summary: Triggered when an order is returned.
      description: |
        Triggered when an order is returned.
      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: |
      Triggered when a subscription is deleted.
    post:
      summary: Triggered when a subscription is deleted.
      description: |
        Triggered when a subscription is deleted.
      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
  payment_source_added:
    description: |
      Triggered when a payment source is added.
    post:
      summary: Triggered when a payment source is added.
      description: |
        Triggered when a payment source is added.
      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
  subscription_moved_in:
    description: |
      Triggered when the subscription is moving in from one customer to another asynchronously.
    post:
      summary: Triggered when a subscription moved from other customer
      description: |
        Triggered when the subscription is moving in from one customer to another asynchronously.
      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
  ledger_updated:
    description: |
      Triggered when a batch of [ledger operations](/docs/api/ledger_operations) is persisted for a subscription unit.
      The event content includes the related `ledger_operations`, `ledger_account_balance`, `grant_blocks`, and `ledger_entries`.
    post:
      summary: Triggered when a batch of ledger operations is persisted for a subscription
        unit.
      description: |
        Triggered when a batch of [ledger operations](/docs/api/ledger_operations) is persisted for a subscription unit.
        The event content includes the related `ledger_operations`, `ledger_account_balance`, `grant_blocks`, and `ledger_entries`.
      operationId: onLedger_updatedWebhook
      requestBody:
        description: Payload for ledger_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/LedgerUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  item_price_created:
    description: |
      Triggered when an item price is created.
    post:
      summary: Triggered when an item price is created.
      description: |
        Triggered when an item price is created.
      operationId: onItem_price_createdWebhook
      requestBody:
        description: Payload for item_price_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ItemPriceCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_scheduled_cancellation_removed:
    description: |
      Triggered when scheduled cancellation is removed for the subscription.
    post:
      summary: Triggered when scheduled cancellation is removed for the subscription.
      description: |
        Triggered when scheduled cancellation is removed for the subscription.
      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: |
      Triggered when a payment refund is made.
    post:
      summary: Triggered when a payment refund is made.
      description: |
        Triggered when a payment refund is made.
      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
  product_created:
    post:
      summary: Triggered when a product resource is created successfully
      operationId: onProduct_createdWebhook
      requestBody:
        description: Payload for product_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ProductCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: true
  omnichannel_subscription_moved_in:
    description: |
      Triggered when an omnichannel subscription is moved to another customer
    post:
      summary: Triggered when an omnichannel subscription is moved to another customer
      description: |
        Triggered when an omnichannel subscription is moved to another customer
      operationId: onOmnichannel_subscription_moved_inWebhook
      requestBody:
        description: Payload for omnichannel_subscription_moved_in event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionMovedInEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  differential_price_created:
    description: |
      Triggered when a differential price is created.
    post:
      summary: Triggered when a differential price is created.
      description: |
        Triggered when a differential price is created.
      operationId: onDifferential_price_createdWebhook
      requestBody:
        description: Payload for differential_price_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DifferentialPriceCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  transaction_created:
    description: |
      Triggered when a transaction is recorded.
    post:
      summary: Triggered when a transaction is recorded.
      description: |
        Triggered when a transaction is recorded.
      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
  omnichannel_subscription_item_downgrade_scheduled:
    post:
      summary: Triggered when an omnichannel subscription item downgrade is scheduled
      operationId: onOmnichannel_subscription_item_downgrade_scheduledWebhook
      requestBody:
        description: Payload for omnichannel_subscription_item_downgrade_scheduled
          event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemDowngradeScheduledEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: true
  payment_succeeded:
    description: |
      Triggered when the payment is successfully collected.
    post:
      summary: Triggered when the payment is successfully collected.
      description: |
        Triggered when the payment is successfully collected.
      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
  subscription_canceled_with_backdating:
    description: |
      Triggered when a subscription is canceled with cancel_at set to a value in the past.
    post:
      summary: Triggered when a subscription is canceled with cancel_at set to a value
        in the past.
      description: |
        Triggered when a subscription is canceled with cancel_at set to a value in the past.
      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
  unbilled_charges_voided:
    description: |
      Triggered when unbilled charges are voided
    post:
      summary: Triggered when unbilled charges are voided
      description: |
        Triggered when unbilled charges are voided
      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: |
      Event triggered when a new quote is generated.
    post:
      summary: Event triggered when a new quote is generated.
      description: |
        Event triggered when a new quote is generated.
      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
  coupon_set_deleted:
    description: |
      Triggered when a coupon set is deleted.
    post:
      summary: Triggered when a coupon set is deleted.
      description: |
        Triggered when a coupon set is deleted.
      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
  attached_item_created:
    description: |
      Triggered when an attached item is created.
    post:
      summary: Triggered when an attached item is created.
      description: |
        Triggered when an attached item is created.
      operationId: onAttached_item_createdWebhook
      requestBody:
        description: Payload for attached_item_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AttachedItemCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  sales_order_created:
    post:
      summary: Triggered when a new sales order is created.
      operationId: onSales_order_createdWebhook
      requestBody:
        description: Payload for sales_order_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SalesOrderCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  customer_changed:
    description: |
      Triggered when customer details are changed, and the payment method role of a customer is updated.
    post:
      summary: Triggered when a customer is changed.
      description: |
        Triggered when customer details are changed, and the payment method role of a customer is updated.
      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: |
      Triggered when a 'future' subscription gets started.
    post:
      summary: Triggered when a 'future' subscription gets started.
      description: |
        Triggered when a 'future' subscription gets started.
      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: |
      Triggered after the subscription has been moved from "Trial" to "Active" state.
    post:
      summary: Triggered after the subscription has been moved from "Trial" to "Active"
        state.
      description: |
        Triggered after the subscription has been moved from "Trial" to "Active" state.
      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: |
      Triggered when the customer's payment source is expiring soon. Triggered 30 days before the expiry date.
    post:
      summary: Triggered when the customer's payment source is expiring soon. Triggered
        30 days before the expiry date.
      description: |
        Triggered when the customer's payment source is expiring soon. Triggered 30 days before the expiry date.
      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: |
      Triggered when the subscription is moved from `cancelled` `status` to `active` or `in_trial`.
    post:
      summary: Triggered when the subscription is moved from `cancelled` `status`
        to `active` or `in_trial`.
      description: |
        Triggered when the subscription is moved from `cancelled` `status` to `active` or `in_trial`.
      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: |
      Triggered when an order is updated.
    post:
      summary: Triggered when an order is updated.
      description: |
        Triggered when an order is updated.
      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: |
      Triggered when scheduled pause is removed for the subscription.
    post:
      summary: Triggered when scheduled pause is removed for the subscription.
      description: |
        Triggered when scheduled pause is removed for the subscription.
      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: |
      Triggered 6 days prior to the scheduled cancellation date.
    post:
      summary: Triggered 6 days prior to the scheduled cancellation date.
      description: |
        Triggered 6 days prior to the scheduled cancellation date.
      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
  subscription_created_with_backdating:
    description: |
      Triggered when a subscription is created and the value of subscription.started_at is in the past.
    post:
      summary: Triggered when a subscription is created and the value of subscription.started_at
        is in the past.
      description: |
        Triggered when a subscription is created and the value of subscription.started_at is in the past.
      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
  subscription_ramp_created:
    description: |
      Triggered when a ramp is created.
    post:
      summary: Triggered when a ramp is created.
      description: |
        Triggered when a ramp is created.
      operationId: onSubscription_ramp_createdWebhook
      requestBody:
        description: Payload for subscription_ramp_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionRampCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  order_deleted:
    description: |
      Triggered when an order is deleted.
    post:
      summary: Triggered when an order is deleted.
      description: |
        Triggered when an order is deleted.
      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
  omnichannel_subscription_item_pause_scheduled:
    description: |
      Triggered when an omnichannel subscription item is scheduled for pause.
    post:
      summary: Triggered when an omnichannel subscription item is scheduled for pause.
      description: |
        Triggered when an omnichannel subscription item is scheduled for pause.
      operationId: onOmnichannel_subscription_item_pause_scheduledWebhook
      requestBody:
        description: Payload for omnichannel_subscription_item_pause_scheduled event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemPauseScheduledEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  gift_updated:
    description: |
      Triggered when a gift is updated.
    post:
      summary: Triggered when a gift is updated.
      description: |
        Triggered when a gift is updated.
      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: |
      Trial Extension
    post:
      summary: Trial Extension
      description: |
        Trial Extension
      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
  omnichannel_subscription_item_grace_period_started:
    description: |
      Triggered when an omnichannel subscription item has entered a grace period.
    post:
      summary: Triggered when an omnichannel subscription item's grace period has
        started
      description: |
        Triggered when an omnichannel subscription item has entered a grace period.
      operationId: onOmnichannel_subscription_item_grace_period_startedWebhook
      requestBody:
        description: Payload for omnichannel_subscription_item_grace_period_started
          event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemGracePeriodStartedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  card_expiry_reminder:
    description: |
      Triggered when the customer's credit card is expiring soon. Triggered 30 days before the expiry date.
    post:
      summary: Triggered when the customer's credit card is expiring soon. Triggered
        30 days before the expiry date.
      description: |
        Triggered when the customer's credit card is expiring soon. Triggered 30 days before the expiry date.
      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: |
      Triggered when a nonce is created.
    post:
      summary: Triggered when a nonce is created.
      description: |
        Triggered when a nonce is created.
      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
  payment_source_business_entity_changed:
    post:
      summary: Triggered when a payment source's business entity is changed
      operationId: onPayment_source_business_entity_changedWebhook
      requestBody:
        description: Payload for payment_source_business_entity_changed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PaymentSourceBusinessEntityChangedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  promotional_credits_added:
    description: |
      Triggered when promotional credit is added.
    post:
      summary: Triggered when promotional credit is added.
      description: |
        Triggered when promotional credit is added.
      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_ramp_updated:
    description: |
      Triggered when a ramp is updated.
    post:
      summary: Triggered when a subscription ramp is updated.
      description: |
        Triggered when a ramp is updated.
      operationId: onSubscription_ramp_updatedWebhook
      requestBody:
        description: Payload for subscription_ramp_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionRampUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  business_rule_deactivated:
    post:
      summary: Triggered when a business rule is deactivated
      operationId: onBusiness_rule_deactivatedWebhook
      requestBody:
        description: Payload for business_rule_deactivated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BusinessRuleDeactivatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  ledger_account_balance_updated:
    description: |
      Triggered when a [ledger account balance](/docs/api/ledger_account_balances) changes for a subscription unit.
      The event content includes the updated `ledger_account_balance`.
    post:
      summary: Triggered when a ledger account balance changes for a subscription
        unit.
      description: |
        Triggered when a [ledger account balance](/docs/api/ledger_account_balances) changes for a subscription unit.
        The event content includes the updated `ledger_account_balance`.
      operationId: onLedger_account_balance_updatedWebhook
      requestBody:
        description: Payload for ledger_account_balance_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/LedgerAccountBalanceUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  vault_token_created:
    post:
      summary: Triggered when a vaulted payment method is created for orchestrator
        vaulting
      operationId: onVault_token_createdWebhook
      requestBody:
        description: Payload for vault_token_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/VaultTokenCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  einvoice_updated:
    description: |
      Triggered when an e-invoice is updated (for example when its status or provider responses change).
    post:
      summary: Triggered when an e-invoice is updated (for example when its status
        or provider responses change).
      description: |
        Triggered when an e-invoice is updated (for example when its status or provider responses change).
      operationId: onEinvoice_updatedWebhook
      requestBody:
        description: Payload for einvoice_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/EinvoiceUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  customer_entitlements_updated:
    description: |
      Triggered when a `customer_entitlement` is updated.
    post:
      summary: Triggered when entitlements for the list of customers got updated.
      description: |
        Triggered when a `customer_entitlement` is updated.
      operationId: onCustomer_entitlements_updatedWebhook
      requestBody:
        description: Payload for customer_entitlements_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CustomerEntitlementsUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  payment_source_expired:
    description: |
      Triggered when the payment source for a customer has expired.
    post:
      summary: Triggered when the payment source for a customer has expired.
      description: |
        Triggered when the payment source for a customer has expired.
      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: |
      Triggered when a customer is copied to another site.
    post:
      summary: Triggered when a customer is copied to another site.
      description: |
        Triggered when a customer is copied to another site.
      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
  business_rule_released:
    post:
      summary: Triggered when a business rule is released
      operationId: onBusiness_rule_releasedWebhook
      requestBody:
        description: Payload for business_rule_released event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BusinessRuleReleasedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_entitlements_updated:
    description: |
      Triggered on subscription change, alongside the subscription_changed event whenever there are updates to a subscription's entitlements resulting from modifications to its recurring and non recurring items. The event payload contains the first 100 subscription_entitlements. The has_next attribute is set to true if more than 100 subscription entitlements are available. You can retrieve the next page by calling the "List subscription entitlements" endpoint, passing the offset parameter as 1.
    post:
      summary: "Triggered on subscription update, alongside the subscription_updated\
        \ event whenever the subscription has subscription_entitlements updated. The\
        \ event payload contains the first 100 subscription_entitlements. The has_next\
        \ attribute is set to true if more than 100 subscription entitlements are\
        \ available. You can retrieve the next page by calling the “List subscription\
        \ entitlements” endpoint, passing the offset parameter as 1."
      description: |
        Triggered on subscription change, alongside the subscription_changed event whenever there are updates to a subscription's entitlements resulting from modifications to its recurring and non recurring items. The event payload contains the first 100 subscription_entitlements. The has_next attribute is set to true if more than 100 subscription entitlements are available. You can retrieve the next page by calling the "List subscription entitlements" endpoint, passing the offset parameter as 1.
      operationId: onSubscription_entitlements_updatedWebhook
      requestBody:
        description: Payload for subscription_entitlements_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionEntitlementsUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  omnichannel_subscription_item_dunning_expired:
    description: |
      Triggered when an omnichannel subscription item's dunning period has expired.
    post:
      summary: Triggered when an omnichannel subscription item's dunning has expired
      description: |
        Triggered when an omnichannel subscription item's dunning period has expired.
      operationId: onOmnichannel_subscription_item_dunning_expiredWebhook
      requestBody:
        description: Payload for omnichannel_subscription_item_dunning_expired event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemDunningExpiredEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  hierarchy_created:
    description: |
      Triggered when a hierarchy is created.
    post:
      summary: Triggered when a hierarchy is created.
      description: |
        Triggered when a hierarchy is created.
      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
  attached_item_deleted:
    description: |
      Triggered when an attached item is deleted.
    post:
      summary: Triggered when an attached item is deleted.
      description: |
        Triggered when an attached item is deleted.
      operationId: onAttached_item_deletedWebhook
      requestBody:
        description: Payload for attached_item_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AttachedItemDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  omnichannel_subscription_item_scheduled_cancellation_removed:
    description: |
      Triggered when an omnichannel subscription item scheduled cancellation is removed.
    post:
      summary: Triggered when an omnichannel subscription item scheduled cancellation
        is removed
      description: |
        Triggered when an omnichannel subscription item scheduled cancellation is removed.
      operationId: onOmnichannel_subscription_item_scheduled_cancellation_removedWebhook
      requestBody:
        description: Payload for omnichannel_subscription_item_scheduled_cancellation_removed
          event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemScheduledCancellationRemovedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  item_updated:
    description: |
      Triggered when an item is updated.
    post:
      summary: Triggered when an item is updated.
      description: |
        Triggered when an item is updated.
      operationId: onItem_updatedWebhook
      requestBody:
        description: Payload for item_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ItemUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  coupon_set_created:
    description: |
      Triggered when a coupon set is created.
    post:
      summary: Triggered when a coupon set is created.
      description: |
        Triggered when a coupon set is created.
      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
  payment_intent_updated:
    description: |
      Triggered when a payment intent is updated.
    post:
      summary: Triggered when a payment intent is updated.
      description: |
        Triggered when a payment intent is updated.
      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
  order_resent:
    description: |
      Triggered when an order is resent.
    post:
      summary: Triggered when an order is resent.
      description: |
        Triggered when an order is resent.
      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
  omnichannel_subscription_item_scheduled_downgrade_removed:
    post:
      summary: Triggered when an omnichannel subscription item scheduled downgrade
        is removed
      operationId: onOmnichannel_subscription_item_scheduled_downgrade_removedWebhook
      requestBody:
        description: Payload for omnichannel_subscription_item_scheduled_downgrade_removed
          event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemScheduledDowngradeRemovedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: true
  omnichannel_subscription_created:
    description: |
      Triggered when an omnichannel subscription is created.
    post:
      summary: Triggered when an omnichannel subscription is created
      description: |
        Triggered when an omnichannel subscription is created.
      operationId: onOmnichannel_subscription_createdWebhook
      requestBody:
        description: Payload for omnichannel_subscription_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  tax_withheld_recorded:
    description: |
      Triggered when a tax withheld is recorded for an invoice.
    post:
      summary: Triggered when a tax withheld is recorded for an invoice.
      description: |
        Triggered when a tax withheld is recorded for an invoice.
      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
  price_variant_created:
    description: |
      Triggered when a price variant resource is created successfully
    post:
      summary: Triggered when a price variant is created.
      description: |
        Triggered when a price variant resource is created successfully
      operationId: onPrice_variant_createdWebhook
      requestBody:
        description: Payload for price_variant_created event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PriceVariantCreatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  differential_price_deleted:
    description: |
      Triggered when a differential price is deleted.
    post:
      summary: Triggered when a differential price is deleted.
      description: |
        Triggered when a differential price is deleted.
      operationId: onDifferential_price_deletedWebhook
      requestBody:
        description: Payload for differential_price_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DifferentialPriceDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  business_rule_activated:
    post:
      summary: Triggered when a business rule is activated
      operationId: onBusiness_rule_activatedWebhook
      requestBody:
        description: Payload for business_rule_activated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BusinessRuleActivatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  subscription_items_renewed:
    description: |
      Triggered when one or more subscription items are renewed.
    post:
      summary: Triggered when one or more Subscription Items are renewed
      description: |
        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: |
      Triggered when contract term is cancelled.
    post:
      summary: Triggered when contract term is cancelled.
      description: |
        Triggered when contract term is cancelled.
      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: |
      Triggered when a contract term is renewed.
    post:
      summary: Triggered when a contract term is renewed.
      description: |
        Triggered when a contract term is renewed.
      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: |
      Event triggered when an invoice is deleted.
    post:
      summary: Event triggered when an invoice is deleted.
      description: |
        Event triggered when an invoice is deleted.
      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
  business_rule_updated:
    post:
      summary: Triggered when a business rule is updated
      operationId: onBusiness_rule_updatedWebhook
      requestBody:
        description: Payload for business_rule_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BusinessRuleUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  item_price_entitlements_removed:
    description: |
      One or more `item_price_entitlement`s were removed for an `item_price` or a `feature`.
    post:
      summary: One or more `item_price_entitlement`s were removed for an `item_price`
        or a `feature`.
      description: |
        One or more `item_price_entitlement`s were removed for an `item_price` or a `feature`.
      operationId: onItem_price_entitlements_removedWebhook
      requestBody:
        description: Payload for item_price_entitlements_removed event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ItemPriceEntitlementsRemovedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  sales_order_updated:
    post:
      summary: Triggered when a sales order is updated.
      operationId: onSales_order_updatedWebhook
      requestBody:
        description: Payload for sales_order_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SalesOrderUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  omnichannel_subscription_item_dunning_started:
    description: |
      Triggered when an omnichannel subscription item has entered a dunning period.
    post:
      summary: Triggered when an omnichannel subscription item's dunning has started
      description: |
        Triggered when an omnichannel subscription item has entered a dunning period.
      operationId: onOmnichannel_subscription_item_dunning_startedWebhook
      requestBody:
        description: Payload for omnichannel_subscription_item_dunning_started event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemDunningStartedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  omnichannel_subscription_item_change_scheduled:
    description: |
      Triggered when an omnichannel subscription item change is scheduled.
    post:
      summary: Triggered when an omnichannel subscription item change is scheduled
      description: |
        Triggered when an omnichannel subscription item change is scheduled.
      operationId: onOmnichannel_subscription_item_change_scheduledWebhook
      requestBody:
        description: Payload for omnichannel_subscription_item_change_scheduled event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OmnichannelSubscriptionItemChangeScheduledEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  pending_invoice_updated:
    description: |
      Triggered when you make the following changes to a pending invoice: add a charge, add a non-recurring addon, or delete a line item.
    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: |
        Triggered when you make the following changes to a pending invoice: add a charge, add a non-recurring addon, or delete a line item.
      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: |
      Triggered when a quote is updated.
    post:
      summary: Triggered when a quote is updated.
      description: |
        Triggered when a quote is updated.
      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
  attached_item_updated:
    description: |
      Triggered when an attached item is updated.
    post:
      summary: Triggered when an attached item is updated.
      description: |
        Triggered when an attached item is updated.
      operationId: onAttached_item_updatedWebhook
      requestBody:
        description: Payload for attached_item_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AttachedItemUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  payment_source_updated:
    description: |
      Triggered when the payment source is updated.
    post:
      summary: Triggered when the payment source is updated and also when a role is
        assigned to it.
      description: |
        Triggered when the payment source is updated.
      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
  business_entity_deleted:
    description: |
      Triggered when a business entity is deleted
    post:
      summary: Triggered when a business entity is deleted
      description: |
        Triggered when a business entity is deleted
      operationId: onBusiness_entity_deletedWebhook
      requestBody:
        description: Payload for business_entity_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BusinessEntityDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  grant_blocks_updated:
    description: |
      Triggered when one or more [grant blocks](/docs/api/grant_blocks) are updated for a subscription unit.
      The event content includes the updated `grant_blocks`.
    post:
      summary: Triggered when one or more grant blocks are updated for a subscription
        unit.
      description: |
        Triggered when one or more [grant blocks](/docs/api/grant_blocks) are updated for a subscription unit.
        The event content includes the updated `grant_blocks`.
      operationId: onGrant_blocks_updatedWebhook
      requestBody:
        description: Payload for grant_blocks_updated event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GrantBlocksUpdatedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false
  authorization_voided:
    description: |
      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.
    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: |
        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.
      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
  subscription_ramp_deleted:
    description: |
      Triggered when a ramp is deleted.
    post:
      summary: Triggered when a ramp is deleted.
      description: |
        Triggered when a ramp is deleted.
      operationId: onSubscription_ramp_deletedWebhook
      requestBody:
        description: Payload for subscription_ramp_deleted event
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SubscriptionRampDeletedEvent"
      responses:
        "200":
          description: Webhook received successfully
      deprecated: false